Descrição
Remova um ou mais vínculos de política de acesso de um grupo de usuários. Os vínculos são desativados em vez de apagados.
Um vínculo que já está inativo é ignorado, então a mesma requisição pode ser repetida com segurança. Um código de identificação que não pertence a este grupo é rejeitado.
Remover todos os vínculos também é o que desbloqueia a exclusão de um grupo, acesse DELETE | Excluir grupo de usuários.
A aplicação pode remover apenas vínculos com políticas de acesso PAM liberadas para sua autorização no A2A. A regra também vale para uma autorização com o Super admin habilitado. Um vínculo com qualquer outra política de acesso é rejeitado como se não existisse, esteja ele ativo ou não. Se a aplicação não tiver uma autorização ativa no A2A, ela não pode remover nenhum vínculo.
Um código rejeitado não interrompe o restante da requisição. Os demais vínculos da requisição são removidos, mesmo quando a resposta é 422.
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.
- Os códigos de identificação dos vínculos, retornados por GET | Listar todas as políticas de acesso de um grupo de usuários.
- Cada vínculo deve vincular uma política de acesso PAM liberada para a autorização da aplicação no A2A. Para mais informações, acesse Como gerenciar autorizações no A2A API v2.
Requisição
POST /api/v2/iam/user-groups/{id}/access-policies/remove
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. |
Cabeçalhos
| Cabeçalho | Obrigatório | Descrição |
|---|---|---|
Content-Type |
Sim | Deve ser application/json. |
Corpo da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
binding_ids |
array[integer] | Sim | Códigos de identificação dos vínculos a remover. O array deve conter pelo menos um valor. Strings numéricas, como "200", também são aceitas. |
Os valores em binding_ids são os códigos de vínculo retornados em data[].id pela listagem, não os códigos de identificação das próprias políticas de acesso. Envie apenas códigos retornados pela listagem.
Exemplo de requisição
POST {{url}}/api/v2/iam/user-groups/7/access-policies/remove
Corpo
{
"binding_ids": ["200", "201"]
}
Resposta
HTTP/1.1 204 No Content
X-Request-Id: 7f3c1a90-2c4e-4b1a-9f5e-0a2b7c9d1e34
Uma remoção bem-sucedida não retorna corpo.
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. Um vínculo com uma política de acesso fora do escopo nunca retorna 404; ele retorna 422. |
Verifique o código de identificação do grupo de usuários e o escopo da autorização. |
422 |
api.validation.required_field |
O corpo não carrega binding_ids. |
Adicione o campo e reenvie a requisição. |
422 |
api.validation.invalid_reference |
Um código de vínculo não existe, pertence a outro grupo de usuários, ou vincula uma política de acesso que não está liberada para a autorização da aplicação no A2A. A mensagem é One or more access-policy bindings not found. Cada código rejeitado em binding_ids recebe uma entrada em details. Os demais vínculos da requisição continuam sendo removidos. |
Liste os vínculos do grupo e use os códigos retornados ali. |
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.