DELETE | Desativar servidor LDAP por [id]

Descrição

Desative um perfil de conexão de servidor LDAP/AD na plataforma Segura™. A operação é uma exclusão lógica (soft delete): o registro é mantido e o servidor sai da cadeia de autenticação.

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.
Nenhuma sincronização de grupo ativa referencia o servidor.

Requisição

DELETE /api/v2/iam/ldap-servers/{id}

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.

Atenção

Este endpoint não verifica If-Match, diferente de PUT | Atualizar servidor LDAP por [id] e PATCH | Atualizar parcialmente servidor LDAP por [id]. Ele exclui o servidor mesmo que o servidor tenha sido alterado depois de ser lido, e ignora um cabeçalho If-Match enviado com a requisição.

Exemplo de requisição

DELETE {{url}}/api/v2/iam/ldap-servers/7

Resposta

HTTP/1.1 204 No Content

A resposta não tem corpo.

Atenção

O servidor é desativado, não removido. Uma requisição posterior a GET | Listar um servidor LDAP por [id] retorna 200 OK com active definido como false, e o servidor continua aparecendo em GET | Listar todos os servidores LDAP quando a listagem não é filtrada por estado.

Para colocar o servidor de volta na cadeia de autenticação, acesse POST | Ativar servidor LDAP.

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.in_use`	Uma sincronização de grupo ativa ainda referencia o servidor.	Desative ou remova toda sincronização de grupo vinculada ao servidor e reenvie a requisição.
`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 sincronizações de grupo ainda referenciam o servidor:

{
    "code": "api.resource.in_use",
    "message": "LDAP server is referenced by active sync groups.",
    "details": [
        { "code": "ldap_server.in_use.sync_groups" }
    ]
}

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