POST | Desativar política de acesso

Prev Next

Descrição

Desative uma política de acesso no PAM Core. Uma política desativada deixa de aplicar o acesso que define, sem ser excluída.

Esta ação é a única forma de suspender uma política. O campo active não pode ser enviado em POST | Criar política de acesso, PUT | Atualizar política de acesso por [id] nem PATCH | Atualizar parcialmente a política de acesso por [id].

Desativar é a alternativa reversível a DELETE | Excluir política de acesso por [id]. Reative a política com POST | Ativar política de acesso.

Atenção

Uma política desativada não pode ser editada. Requisições de atualização em uma política inativa são rejeitadas com 409 e o código api.resource.inactive, portanto a política precisa ser reativada antes de qualquer nova alteração, o que torna seu acesso ativo novamente. Aplique suas alterações antes de desativar.


Pré-requisitos

  • Uma aplicação com a autorização Access Policy (V2) concedida pelo administrador no A2A, com a Permissão do recurso PAM definida como Leitura e escrita. Para mais informações, acesse Como gerenciar autorizações no A2A.
  • Um token de acesso OAuth 2.0 válido. Para mais informações, acesse Como autenticar uma aplicação A2A.
  • A política de acesso deve estar ativa. Desativar uma política já inativa retorna 409.
Info

Um token de acesso carrega apenas as autorizações que existiam no momento em que foi gerado. Depois que o administrador habilitar a autorização Access Policy (V2), gere um novo token para a aplicação, um token existente não passa a ter a nova autorização.


Requisição

POST /api/v2/pam/access-policies/{id}/deactivate

Parâmetros de caminho

Campo Tipo Obrigatório Descrição
id integer Sim Código de identificação único da política de acesso. Nota: este valor é atribuído pelo Segura® em POST | Criar política de acesso.

A requisição não tem corpo.


Exemplo de requisição

POST {{url}}/api/v2/pam/access-policies/3001/deactivate


Resposta

HTTP/1.1 204 No Content

A resposta não tem corpo. Para confirmar o novo estado, obtenha a política com GET | Listar uma política de acesso por [id].


Erros

Código HTTP Mensagem Causa possível Solução
401 api.auth.token.invalid O token de acesso está ausente ou expirou. Solicite um novo token de acesso.
403 api.permission.denied A autorização não tem permissão para atualizar políticas de acesso. Peça ao administrador para verificar a autorização Access Policy (V2) e a Permissão do recurso PAM no A2A e gere um novo token.
404 api.resource.not_found A política de acesso não existe ou está fora do escopo da autorização. Verifique o código de identificação enviado no caminho.
409 api.resource.conflict.already_inactive A política de acesso já está inativa. Nenhuma ação é necessária, a política já está no estado solicitado.
429 rate_limit_exceeded O limite de requisições foi excedido. Reduza a frequência de requisições e tente novamente.
500 api.internal.error Erro interno do servidor. Entre em contato com a equipe de suporte da Segura®.

Exemplo de resposta de erro

409 a política já está inativa:

{
    "error": {
        "code": "api.resource.conflict.already_inactive",
        "message": "Access policy is already inactive."
    }
}
Info

Esta ação não é idempotente. Repeti-la em uma política que já está inativa retorna 409 em vez de 204. Obtenha o estado atual da política antes de reenviar uma requisição cujo resultado você desconhece.

Para mensagens de erros de autenticação e a política de 403 versus 404, acesse API v2 - Convenções e comportamentos compartilhados.