GET | Consultar sincronização de grupo LDAP por [id]

Descrição

Acesse todas as configurações de uma sincronização de grupo LDAP na plataforma Segura™. A resposta carrega o modelo canônico completo, o ETag necessário para atualizar ou excluir o recurso, e as ações de estado disponíveis no momento para ele.

Pré-requisitos

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

Requisição

GET /api/v2/iam/ldap-group-syncs/[id]

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
`id`	int	Sim	Código de identificação único da sincronização. Observação: esse valor é atribuído pela Segura™ em [POST

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

Resposta

HTTP/1.1 200 OK
ETag: "174f80fa9c3b4d2e"

Guarde o valor do ETag. PUT | Atualizar sincronização de grupo LDAP por [id], PATCH | Atualizar parcialmente sincronização de grupo LDAP por [id] e DELETE | Excluir sincronização de grupo LDAP por [id] o utilizam no header If-Match para detectar alterações concorrentes.

Exemplo de corpo da resposta

{
    "data": {
        "id": "501",
        "group_sync": {
            "name": "Infrastructure operators",
            "active": true,
            "server": { "id": "10" },
            "user_group": { "id": "7" },
            "synchronization_enabled": true,
            "overwrite_user_accesses": false,
            "force_roles": true,
            "automatic_sync": false,
            "dn": "OU=Operators,DC=example,DC=com",
            "ad_username_attribute": "sAMAccountName",
            "ad_name_attribute": "displayname",
            "department": null,
            "ad_query": "(&(objectClass=group)(cn=ops-*))",
            "roles": [{ "id": 1 }, { "id": 3 }]
        },
        "domum": {
            "enabled": true,
            "type": "limited_users",
            "vendor": { "id": 22 }
        }
    },
    "meta": {
        "links": { "self": "/api/v2/iam/ldap-group-syncs/501" },
        "actions": {
            "sync": "/api/v2/iam/ldap-group-syncs/501/sync",
            "deactivate": "/api/v2/iam/ldap-group-syncs/501/deactivate"
        }
    }
}

Campos do corpo da resposta

Campo	Tipo	Descrição
`data`	object	A sincronização.
`meta`	object	Links e as ações disponíveis para o recurso em seu estado atual.

`data`

Campo	Tipo	Descrição
→`id`	string	Código de identificação único da sincronização.
→`group_sync`	object	As configurações da sincronização.
→`domum`	object	As configurações do Domum. Retornado apenas quando o módulo de licença `cote` está ativo.

`data.group_sync`

Campo	Tipo	Descrição
→→`name`	string	Nome da sincronização.
→→`active`	boolean	Indica se a sincronização está ativa.
→→`server`	object	O servidor LDAP, como `{ "id": <string> }`.
→→`user_group`	object	O grupo de usuários, como `{ "id": <string> }`.
→→`synchronization_enabled`	boolean	Indica se a sincronização está habilitada para rodar.
→→`overwrite_user_accesses`	boolean	Indica se a sincronização sobrescreve os acessos já atribuídos a um usuário.
→→`force_roles`	boolean	Indica se a sincronização remove roles que o grupo do Active Directory não concede mais.
→→`automatic_sync`	boolean	Indica se a plataforma executa a sincronização em sua própria agenda.
→→`dn`	string	Distinguished name base pesquisado no diretório.
→→`ad_username_attribute`	string	Atributo do Active Directory lido como o nome de usuário.
→→`ad_name_attribute`	string	Atributo do Active Directory lido como o nome completo. Retorna `null` quando nenhum atributo suportado está armazenado.
→→`department`	object	O departamento atribuído aos usuários sincronizados. Retorna `null` quando não definido.
→→`ad_query`	string	Filtro LDAP que seleciona os grupos a sincronizar.
→→`roles`	array de objetos	As roles de ACL atribuídas, cada uma como `{ "id": <int> }`.

`data.domum`

Campo	Tipo	Descrição
→→`enabled`	boolean	Indica se os usuários sincronizados recebem acesso no Domum.
→→`type`	string	Perfil de acesso concedido no Domum. Retorna `full_users` ou `limited_users`.
→→`vendor`	object	O fornecedor ou grupo interno, como `{ "id": <int> }`.

`meta.actions`

As ações refletem o estado atual do recurso. Uma sincronização ativa oferece sync e deactivate; uma inativa oferece sync e activate.

Campo	Tipo	Descrição
→→`sync`	string	Caminho de [POST
→→`activate`	string	Caminho de [POST
→→`deactivate`	string	Caminho de [POST

Info

Uma sincronização excluída com DELETE | Excluir sincronização de grupo LDAP por [id] ainda responde a esta requisição. Ela retorna 200 OK com active definido como false, não 404.

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.
`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.