Skip to content
Dashboard
Theme
Theme

Preview a pulled directory source sync

POST /v1/directories/{dir}/source/preview: Preview a pulled directory source sync.

View Markdown

POST /v1/directories/{dir}/source/preview

Reads the source once with its saved credentials and reports what a sync would change, without changing anything (the CSV import dry run). Not found until credentials are saved. Refused credentials answer directory_source_credentials_invalid, an unreachable source directory_source_unavailable, unreadable data directory_csv_invalid.

Scope
directories:write
Auth
Secret key (sk_…)
Since
1.0
  • dir string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source/preview" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"object": "directory_sync",
"directory_id": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"dry_run": true,
"users_created": 1,
"users_updated": 1,
"users_deleted": 1,
"groups_created": 1,
"groups_updated": 1,
"groups_deleted": 1,
"users_skipped": 1,
"skipped": [
{
"external_id": "acme-123",
"name": "Acme Corp",
"reason": "no_id"
}
]
}