---
title: "Returns the current state of the LDAP background sync integration."
method: GET
path: "/admin/ldap-sync-status"
tags: ["admin_ldap", "enterprise"]
---

# Returns the current state of the LDAP background sync integration.

`GET /admin/ldap-sync-status`

## Request

- Base URL: `/api` (relative, and the document’s source URL is not known)
- URL: `/api/admin/ldap-sync-status`
- Auth: one of:
  - HTTP basic
  - API key in header `Authorization`

You need to have a permission with action `ldap.status:read`.

## Response `200`

(empty)

- ActiveSyncStatusDTO: ActiveSyncStatusDTO holds the information for LDAP background Sync
  - `enabled` boolean
  - `nextSync` string, date-time
  - `prevSync` SyncResult
    - `Elapsed` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.
    - `FailedUsers` FailedUser[]
      - `Error` string
      - `Login` string
    - `MissingUserIds` integer[]
    - `Started` string, date-time
    - `UpdatedUserIds` integer[]
  - `schedule` string

## Other responses

- `401`: UnauthorizedError is returned when the request is not authenticated.
- `403`: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
- `500`: InternalServerError is a general error indicating something went wrong internally.

---

[API](https://skmtc.dev/grafana/apis/grafana-http-api.md) - [All operations](https://skmtc.dev/grafana/apis/grafana-http-api/llms.txt) - [OpenAPI document](https://skmtc.dev/grafana/apis/grafana-http-api/revisions/df55ba1718ba?raw)