---
title: "GET | Listar todas as sincronizações de grupos LDAP"
slug: "api-v2-get-list-all-ldap-group-syncs"
updated: 2026-11-03T14:57:57Z
published: 2026-11-03T14:57:57Z
canonical: "docs.senhasegura.io/api-v2-get-list-all-ldap-group-syncs"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.senhasegura.io/llms.txt
> Use this file to discover all available pages before exploring further.

# GET | Listar todas as sincronizações de grupos LDAP

## Descrição

Liste as sincronizações de grupos LDAP registradas na plataforma Segura™. Cada item é um resumo. Para acessar todas as configurações de uma sincronização, acesse [GET | Consultar sincronização de grupo LDAP por [id]](/v4-2/docs/api-v2-get-list-an-ldap-group-sync).

---

## 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](/v4-2/docs/how-to-manage-authorizations-in-a2a).
- Um token de acesso OAuth 2.0 válido. Para mais informações, acesse [Como autenticar uma aplicação no A2A](/v4-2/docs/how-to-authenticate-an-application-in-a2a).

---

## Requisição

`GET` `/api/v2/iam/ldap-group-syncs`

### Parâmetros de query

Os filtros seguem o modelo canônico, então cada campo carrega seu prefixo de objeto. Enviar um filtro sem o prefixo retorna `400`.

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `group_sync.name` | string | Não | Correspondência exata com o nome da sincronização. |
| `group_sync.active` | boolean | Não | Filtra pelo estado ativo. Aceita `true` ou `false`. |
| `group_sync.server_id` | int | Não | Filtra pelo servidor LDAP. |
| `group_sync.user_group_id` | int | Não | Filtra pelo grupo de usuários. |
| `group_sync.synchronization_enabled` | boolean | Não | Filtra se a sincronização está habilitada para rodar. |
| `group_sync.automatic_sync` | boolean | Não | Filtra se a plataforma executa a sincronização em sua própria agenda. |
| `group_sync.last_sync_succeeded` | boolean | Não | Filtra pelo resultado da última execução. |
| `domum.enabled` | boolean | Não | Filtra se o bloco Domum está habilitado. |
| `search` | string | Não | Busca por substring em `name`, `dn` e `ad_query`. |
| `sort_by` | string | Não | Segmentos `campo:asc` ou `campo:desc` separados por vírgula. Campos ordenáveis: `id`, `group_sync.name`, `group_sync.active`, `group_sync.last_sync_at`, `group_sync.created_at`, `group_sync.updated_at`. Padrão: `group_sync.name:asc`. |
| `fields` | string | Não | Caminhos canônicos separados por vírgula que limitam os campos retornados. |
| `page` | int | Não | Página do conjunto de resultados. Padrão: `1`. |
| `limit` | int | Não | Número máximo de resultados por página. Padrão: `50`. |

              Atenção

              

O prefixo é obrigatório. `?group_sync.active=true` retorna a lista filtrada, enquanto `?active=true` retorna `400`. O mesmo vale para a ordenação: `sort_by=group_sync.name:asc` é válido e `sort_by=name:asc` retorna `422 api.enum.invalid_value`.

### Exemplo de requisição `GET` `{{url}}/api/v2/iam/ldap-group-syncs?group_sync.active=true&sort_by=group_sync.name:asc&page=1&limit=50`

---

## Resposta

```
HTTP/1.1 200 OK
```

Cada item em `data` é um resumo simples. Os objetos aninhados `group_sync` e `domum` aparecem apenas na resposta de detalhe.

### Exemplo de corpo da resposta

```
{
    "data": [
        {
            "id": "501",
            "name": "Infrastructure operators",
            "active": true,
            "server_id": "10",
            "user_group_id": "7",
            "synchronization_enabled": true,
            "automatic_sync": false,
            "last_sync_at": "2026-06-02T14:21:08-03:00",
            "last_sync_succeeded": true,
            "domum_enabled": true
        },
        {
            "id": "502",
            "name": "Finance auditors",
            "active": false,
            "server_id": "10",
            "user_group_id": "12",
            "synchronization_enabled": false,
            "automatic_sync": false,
            "last_sync_at": null,
            "last_sync_succeeded": null,
            "domum_enabled": false
        }
    ],
    "meta": {
        "pagination": {
            "page": 1,
            "limit": 50,
            "total_items": 2,
            "total_pages": 1
        }
    }
}
```

## Campos do corpo da resposta

| Campo | Tipo | Descrição |
| --- | --- | --- |
| `data` | array de objetos | As sincronizações que atendem à requisição. |
| `meta` | object | Metadados de paginação. |

### `data`

| Campo | Tipo | Descrição |
| --- | --- | --- |
| →`id` | string | Código de identificação único da sincronização, atribuído pela Segura™. |
| →`name` | string | Nome da sincronização. |
| →`active` | boolean | Indica se a sincronização está ativa. |
| →`server_id` | string | Código de identificação do servidor LDAP. |
| →`user_group_id` | string | Código de identificação do grupo de usuários. Retorna `null` quando nenhum grupo está vinculado. |
| →`synchronization_enabled` | boolean | Indica se a sincronização está habilitada para rodar. |
| →`automatic_sync` | boolean | Indica se a plataforma executa a sincronização em sua própria agenda. |
| →`last_sync_at` | string | Data e hora da última execução, em formato ISO 8601. Exemplo: `2026-06-02T14:21:08-03:00`. Retorna `null` quando a sincronização nunca foi executada. |
| →`last_sync_succeeded` | boolean | Resultado da última execução. Retorna `null` quando a sincronização nunca foi executada. |
| →`domum_enabled` | boolean | Indica se o bloco Domum está habilitado. |

### `meta.pagination`

| Campo | Tipo | Descrição |
| --- | --- | --- |
| →→`page` | int | Página atual. |
| →→`limit` | int | Número máximo de resultados por página. |
| →→`total_items` | int | Número total de sincronizações que atendem aos filtros. |
| →→`total_pages` | int | Número total de páginas. |

---

## Erros

| Código HTTP | Mensagem | Causa possível | Solução |
| --- | --- | --- | --- |
| `400` | `api.request.malformed` | Um filtro foi enviado sem seu prefixo canônico. | Prefixe o campo com `group_sync.` ou `domum.`. |
| `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. |
| `422` | `api.enum.invalid_value` | `sort_by` indica um campo que não é ordenável, ou omite o prefixo canônico. | Envie um dos campos ordenáveis listados na tabela de parâmetros de query. |
| `422` | `api.validation.invalid_field` | `fields` contém um caminho que não faz parte do modelo canônico. | Verifique os caminhos de campo 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. |