POST | Ativar servidor LDAP

Prev Next

Descrição

Ative um perfil de conexão de servidor LDAP/AD na plataforma Segura™. Um servidor ativo volta para a cadeia de autenticação e passa a aceitar alterações de configuração.


Pré-requisitos


Requisição

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

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/activate


Resposta

HTTP/1.1 204 No Content

A resposta não tem corpo.

Info

Depois da ativação, GET | Listar um servidor LDAP por [id] retorna active definido como true, e meta.actions oferece deactivate no lugar de activate.

Ativar um servidor não valida se o diretório está acessível. Para verificar a conexão, acesse POST | Testar conexão do servidor LDAP por [id].


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_active O servidor já está ativo. 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á ativo:

{
    "code": "api.resource.conflict.already_active",
    "message": "LDAP server is already active.",
    "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.