POST | Executar sincronização de grupo LDAP

Descrição

Inicie uma execução de sincronização de grupo LDAP na plataforma Segura™. A execução cria e atualiza os usuários encontrados no grupo do Active Directory, propaga suas roles de ACL e reprocessa as políticas de acesso relacionadas.

O trabalho é assíncrono. A plataforma o enfileira e responde imediatamente com um descritor de job, então a resposta confirma que a execução foi aceita, não que ela terminou.

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 no A2A.
A sincronização deve estar ativa. Executar uma sincronização inativa retorna 409.

Requisição

POST /api/v2/iam/ldap-group-syncs/[id]/sync

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
`id`	int	Sim	Código de identificação único da sincronização.

Cabeçalhos

Cabeçalho	Obrigatório	Descrição
`Content-Type`	Sim	Deve ser `application/json`, mesmo que a requisição não carregue corpo.

Exemplo de requisição `POST` `{{url}}/api/v2/iam/ldap-group-syncs/501/sync`

Resposta

HTTP/1.1 202 Accepted
Location: /api/v2/iam/jobs/job-7b3f

O header Location carrega o caminho do job criado para esta execução. Consulte esse caminho para acompanhar o resultado.

Exemplo de corpo da resposta

{
    "data": {
        "job": {
            "id": "job-7b3f",
            "type": "sync",
            "state": "queued"
        }
    },
    "meta": {
        "links": { "self": "/api/v2/iam/jobs/job-7b3f" }
    }
}

Campos do corpo da resposta

Campo	Tipo	Descrição
`data`	object	O job criado para esta execução.
`meta`	object	Links para o job.

`data.job`

Campo	Tipo	Descrição
→→`id`	string	Código de identificação único do job. Use-o para consultar o status do job.
→→`type`	string	O tipo de trabalho enfileirado. Retorna `sync` para esta ação.
→→`state`	string	Estado do job no momento da resposta. Um job recém-aceito retorna `queued`.

`meta.links`

Campo	Tipo	Descrição
→→`self`	string	Caminho do job, correspondente ao header `Location`.

Info

Os endpoints de status e retry de jobs são compartilhados entre os recursos do iam e são documentados separadamente.

Erros

Código HTTP	Mensagem	Causa possível	Solução
`403`	`api.permission.denied`	A aplicação não tem permissão para este recurso.	Peça ao administrador para verificar a autorização Users da aplicação no A2A.
`404`	`api.resource.not_found`	Não existe sincronização com o código de identificação enviado.	Verifique o `id` e reenvie a requisição.
`409`	`api.resource.inactive`	A sincronização está inativa.	Ative-a com [POST
`429`	`rate_limit_exceeded`	A aplicação excedeu sua cota de requisições.	Aguarde o período indicado no header `Retry-After` e reenvie a requisição.

Erros de autenticação

Mensagem	Causa possível	Solução
`Client authentication failed.`	Falha na autenticação da aplicação com o servidor Segura.	Verifique os parâmetros de autenticação (`Access Token URL`, `Client ID` e `Client secret`) e solicite um novo token de acesso.
`Invalid signature`	Falha no reconhecimento da URL da aplicação cliente.	Verifique a URL da aplicação cliente e reenvie a requisição.
`No route matched with those values.`	Header de autorização ausente na requisição da API.	Solicite um novo token de acesso.
`Request timed out.`	A requisição excedeu o limite de tempo.	Verifique a conectividade entre a origem da requisição e o servidor Segura.