---
title: "Manually triggers synchronization of users from directories."
method: POST
path: "/dx/api/people/v1/user-directories/sync"
tags: ["Federation / User directories"]
---

# Manually triggers synchronization of users from directories.

`POST /dx/api/people/v1/user-directories/sync`

Initiates a manual synchronization process for all users across configured user directories, comparing them with locally stored versions and updating as necessary.
  This operation can create, update, or clean up user profiles based on the comparison and may relay updates to other services or systems.
  Note: This endpoint is intended for ad-hoc manual synchronization or testing purposes and executes on a scheduled configuration at the service level.
  Due to its intensive resource usage, it should be used with caution.

## Response `200`

Synchronization process completed successfully.

## Other responses

- `401` — Unauthorized. The user is not authenticated or lacks admin privileges.
- `403` — Forbidden. The user does not have permission to create a new user profile.
- `409` — Conflict. A synchronization process is already in progress. Please wait for the current process to complete.

---

[API](https://skmtc.net/hcl-tech-software/apis/people-api-v1-server.md) · [All operations](https://skmtc.net/hcl-tech-software/apis/people-api-v1-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hcl-tech-software/people-api-v1-server/versions/2267cfc94cf0/schema)