Sync a CSV directory from an uploaded CSV file
POST /v1/directories/{dir}/csv_imports: Sync a CSV directory from an uploaded CSV file.
POST /
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
Path parameters
Section titled “Path parameters”dirstring Required
Query parameters
Section titled “Query parameters”dry_runbooleandefault
false
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”Content type text/csv.
Responses
Section titled “Responses”- 200 OK DirectorySyncResult
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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"const response = await fetch("https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/csv_imports", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/csv_imports", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "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" } ]}