POST | Desativar servidor LDAP

Descrição

Desative um perfil de conexão de servidor LDAP/AD na plataforma Segura™. Um servidor inativo sai da cadeia de autenticação e deixa de participar da autenticação de usuários.

Pré-requisitos

Uma aplicação com a autorização Users concedida pelo administrador no A2A, com a permissão do recurso 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.

Requisição

POST /api/v2/iam/ldap-servers/{id}/deactivate

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
`id`	integer	Sim	Código de identificação único do servidor LDAP. Nota: este valor é atribuído pela Segura™ em POST \| Criar servidor LDAP.

A requisição não leva corpo.

Exemplo de requisição

POST {{url}}/api/v2/iam/ldap-servers/7/deactivate

Resposta

HTTP/1.1 204 No Content

A resposta não tem corpo.

Atenção

A desativação não é propagada. As sincronizações de grupo vinculadas ao servidor mantêm seu próprio estado, e os usuários e papéis já provisionados a partir do diretório permanecem inalterados.

Um servidor inativo também recusa alterações de configuração: PUT | Atualizar servidor LDAP por [id] e PATCH | Atualizar parcialmente servidor LDAP por [id] retornam 409 api.resource.inactive até que o servidor seja ativado novamente.

Erros

Código HTTP	Mensagem	Causa possível	Solução
`401`	`api.auth.unauthorized`	O token de acesso está ausente ou expirou.	Solicite um novo token de acesso.
`404`	`api.resource.not_found`	O servidor não existe.	Verifique o código de identificação enviado no caminho.
`409`	`api.resource.conflict.already_inactive`	O servidor já está inativo.	Nenhuma ação é necessária.
`429`	`api.rate_limit.exceeded`	O limite de requisições foi excedido.	Reduza a frequência de requisições e tente novamente.

Exemplo de resposta de erro

409 o servidor já está inativo:

{
    "code": "api.resource.conflict.already_inactive",
    "message": "LDAP server is already inactive.",
    "details": null
}

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