Skip to content
Dashboard
Theme
Theme

Sync a CSV directory from an uploaded CSV file

POST /v1/directories/{dir}/csv_imports: Sync a CSV directory from an uploaded CSV file.

View Markdown

POST /v1/directories/{dir}/csv_imports

Replaces the users and groups of a directory whose provider is csv with the content of the file, applying only the differences: the same normalized dsync.* events as a SCIM directory, and nothing at all when the file matches the directory. Columns (header row, case-insensitive): external_id (required), user_name, email (one of the two required; user_name defaults to email), given_name, family_name, display_name, active (true/false, default true), title, department, employee_number, groups (group names separated by semicolons). At most 10 MiB and 50,000 users; unknown columns, duplicate external IDs or user names and invalid emails answer directory_csv_invalid naming up to 20 rows. A file that would delete more than half of a directory of 20 or more users answers directory_source_mass_delete_refused. With dry_run=true the counts are computed and nothing is written. A directory of another provider answers directory_source_mismatch.

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

  • dry_run boolean

    default false

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

Content type text/csv.

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/csv_imports" \
-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"
}
]
}