Descrição
Desative um grupo de usuários. Todos os vínculos de membro do grupo são removidos junto com ele, e o grupo permanece cadastrado na plataforma como inativo. Enquanto o grupo estiver inativo, PUT | Atualizar grupo de usuários, PATCH | Atualizar parcialmente grupo de usuários e alterações de membros retornam 409 api.resource.inactive.
A desativação é uma ação dedicada e não um campo, então o estado active não pode ser alterado por PUT | Atualizar grupo de usuários ou PATCH | Atualizar parcialmente grupo de usuários. Excluir um grupo tem o mesmo efeito sobre o grupo e seus vínculos de membro. Para mais informações, acesse DELETE | Excluir grupo de usuários.
Pré-requisitos
- Uma aplicação com a autorização Users concedida pelo administrador no A2A. Para mais informações, acesse Como gerenciar autorizações no A2A API v2.
- Um token de acesso OAuth 2.0 válido. Para mais informações, acesse Como autenticar uma aplicação A2A.
Requisição
POST /api/v2/iam/user-groups/{id}/deactivate
Esta ação não recebe corpo de requisição.
Parâmetros de path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id |
integer | Sim | Código de identificação único do grupo de usuários. |
Exemplo de requisição
POST {{url}}/api/v2/iam/user-groups/7/deactivate
Resposta
HTTP/1.1 204 No Content
X-Request-Id: 7f3c1a90-2c4e-4b1a-9f5e-0a2b7c9d1e34
Uma desativação bem-sucedida não retorna corpo. Para confirmar o novo estado, acesse GET | Consultar um grupo de usuários.
Desativar um grupo remove todos os seus vínculos de membro. Os usuários mantêm suas contas, mas perdem o acesso que esse grupo concedia a eles. POST | Ativar grupo de usuários não restaura os vínculos, então registre os membros antes de desativar o grupo. Para a lista atual, acesse GET | Listar todos os membros de um grupo de usuários.
Erros
| Código HTTP | Mensagem | Possível causa | Solução |
|---|---|---|---|
401 |
api.auth.unauthorized |
O token de acesso está ausente, inválido ou expirou. | Solicite um novo token de acesso. |
404 |
api.resource.not_found |
O grupo de usuários não existe, ou está fora do escopo da autorização. | Verifique o código de identificação e o escopo da autorização. |
409 |
api.resource.conflict.already_inactive |
O grupo de usuários já está inativo. | Nenhuma ação é necessária. |
429 |
api.rate_limit_exceeded |
O limite de requisições foi excedido. | Aguarde o número de segundos retornado no cabeçalho Retry-After e tente novamente. |
Para as mensagens de erro de autenticação e a política de 403 versus 404, acesse API v2 - Convenções e comportamentos compartilhados.