---
title: "Run the directory synchronization."
method: POST
path: "/directorysync/synchronize.json"
tags: ["Directory Sync"]
---

# Run the directory synchronization.

`POST /directorysync/synchronize.json`

## Request

- Base URL: `https://passbolt.local`
- URL: `https://passbolt.local/directorysync/synchronize.json`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/passbolt/apis/passbolt-api/docs/directorysync/synchronize.json/post.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Operation is successful

- object
  - `header` Header, required
    - `id` string, uuid, required
    - `status` 'success' | 'error', required
    - `servertime` integer, required
    - `action` string, uuid, required
    - `message` string, required
    - `url` string, uri, required
    - `code` integer, required
  - `body` SynchronizeAndSimulate, required
    - `users` object[], required
      - `message` string
      - `model` string
      - `data` object
        - `username` string
        - `profile` object
          - `first_name` string
          - `last_name` string
          - `user_id` string
          - `created` string, date-time
          - `modified` string, date-time
          - `id` string, uuid
        - `role_id` string, uuid
        - `deleted` boolean
        - `created` string, date-time
        - `modified` string, date-time
        - `id` string, uuid
        - `last_logged_in` string, date-time
      - `action` string
      - `status` string
      - `created` string, date-time
      - `version` string

## Other responses

- `401`: Authentication required.
- `403`: Access restricted
- `404`: Not found

---

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