---
title: "Request identity sync run"
method: POST
path: "/api/v1/edit/identity-provider-sync"
tags: ["Identity Provider"]
---

# Request identity sync run

`POST /api/v1/edit/identity-provider-sync`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/edit/identity-provider-sync`
- Auth: API key in header `X-API-Key`

Queues a sync run of the Identity Provider (Keycloak and LDAP, admins only). The identity-sync cron starts it within a minute. `preview` lists the changes without applying them, `run` applies them, `force` applies them without the change limit (offboarding_limit).

## Request body

- object
  - `items` unknown[]
    - unknown
  - `attr` object
    - `mode` 'preview' | 'run' | 'force'

## Response `200`

OK

## Other responses

- `401`: Unauthorized

## Changes

- **2026-10-27** `c818e639f1cb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/mailcow/apis/mailcow-api/changes/api/v1/edit/identity-provider-sync/post.md)

---

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