Usuários e grupos
Consulte os grupos de um usuário, adicione um usuário a um grupo e remova um usuário de um grupo.
Este guia mostra como gerenciar a participação dos usuários em grupos. Gerenciar bem os grupos é essencial para controlar o acesso, aplicar regras de preço especiais e oferecer experiências personalizadas. Você verá como consultar as participações de um usuário, adicioná-lo a um grupo e removê-lo de um grupo.
Consultar as participações de um usuário
Para saber a quais grupos um usuário pertence, use GET com o ID do usuário. A chamada devolve todas as participações do usuário, com o status dele em cada grupo, exceto os grupos com status Available (disponível).
/api/users/{id}/usergroupsAdminRetorna todas as participações de um usuário em grupos
Parâmetros de caminho
idintegerobrigatóriouser_id do usuário.Exemplo de requisição
Esta requisição retorna todos os grupos a que o usuário com user_id=3 está associado, exceto os que têm status Available.
curl "$BASE_URL/api/users/3/usergroups" \
-u "$EMAIL:$API_KEY"Parâmetros da resposta
| Parâmetro | Descrição |
|---|---|
link_id | O ID do vínculo que atribui o usuário ao grupo. |
usergroup_id | O ID do grupo de usuários. |
status | O status do usuário no grupo. |
Valores de status
| Código | Status | Descrição |
|---|---|---|
A | Ativo (Active) | O usuário é membro do grupo. |
F | Disponível (Available) | O usuário não é membro do grupo. |
P | Pendente (Pending) | O usuário pediu para entrar no grupo. |
D | Recusado (Declined) | O pedido do usuário para entrar no grupo foi recusado. |
Adicionar um usuário a um grupo
Para adicionar um usuário a um grupo, mude o status dele no grupo para Active (ativo).
/api/users/{user_id}/usergroups/{group_id}AdminAtualiza o status de um usuário em um grupo específico
Parâmetros de caminho
user_idintegerobrigatóriouser_id do usuário.group_idintegerobrigatóriousergroup_id do grupo.Corpo da requisição
statusstringobrigatórioAFPDA para adicionar o usuário.Exemplo de requisição
Esta requisição adiciona o usuário com user_id=3 ao grupo com usergroup_id=5, definindo o status como Active.
curl -X PUT "$BASE_URL/api/users/3/usergroups/5" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: text/plain" \
--data-binary 'status=A'Resposta de sucesso
Se o usuário for adicionado ao grupo com sucesso, você recebe a mensagem Status has been changed.
Erros
| Status | Descrição |
|---|---|
400 Bad Request | O grupo de usuários não existe, ou você está tentando adicionar um cliente a um grupo de administradores. |
404 Not Found | O usuário não existe. |
Remover um usuário de um grupo
Há duas formas de remover um usuário de um grupo.
Método 1: mudar o status para Disponível
Use PUT na mesma URL e defina o status como Available (F).
curl -X PUT "$BASE_URL/api/users/3/usergroups/5" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: text/plain" \
--data-binary 'status=F'Método 2: usar o DELETE
Use o método DELETE para remover o usuário do grupo.
/api/users/{user_id}/usergroups/{group_id}AdminRemove um usuário de um grupo
Parâmetros de caminho
user_idintegerobrigatóriouser_id do usuário.group_idintegerobrigatóriousergroup_id do grupo.curl -X DELETE "$BASE_URL/api/users/3/usergroups/5" \
-u "$EMAIL:$API_KEY"