Skip to main content

List directory sync sources

List directory sync sources. GET /api/openapi/v1/directory-sync/sources, scope admin.v1.directory-sync-config.read.

  • Scope: admin.v1.directory-sync-config.read
  • Permission: Read directory sync configuration (directory-sync-config)
  • Permission type: Read
  • Endpoint: GET/api/openapi/v1/directory-sync/sources

Authentication and request headers

Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
NameLocationTypeRequiredDescriptionExample
AuthorizationheaderstringYesApplication API key, passed as a Bearer token.Bearer qwk_***
X-Request-IdheaderstringNoOptional request tracing identifier; generated by the server if omitted.req-20260831-001

Request parameters

This endpoint has no additional request parameters.

Request example

cURL

Responses

200 OK
NameTypeRequiredDescriptionExample
sourcesarray<OpenapifacadeDirectorySource>YesSources[{"config_revision":0,"connection_status":"<string>","created_at":"2026-08-27T10:00:00Z","created_by_email":"<string>","created_by_name":"<string>","credential_configured":false,"default_seat":false,"deletion_alert_email":"<string>","deletion_alert_enabled":false,"deletion_alert_threshold":0,"deletion_policy":"<string>","external_id_field":"<string>","external_id_field_locked":false,"id":"<uuid>","last_activity_at":"2026-08-27T10:00:00Z","last_connected_at":"2026-08-27T10:00:00Z","last_connection_error_code":"<string>","modified_at":"2026-08-27T10:00:00Z","name":"<string>","next_run_at":"2026-08-27T10:00:00Z","schedule":"<string>","schedule_anchor_at":"2026-08-27T10:00:00Z","settings":{"connection":{"client_name":"<string>","tls_enabled":false,"url":"<string>"},"department_mapping":{"external_id":"<string>","name":"<string>","order":"<string>","parent_external_id":"<string>","status":"<string>"},"mapping":{"account":"<string>","department_external_id":"<string>","email":"<string>","employee_no":"<string>","external_id":"<string>","name":"<string>","phone":"<string>","status":"<string>"},"scope":{"base_dn":"<string>","mode":"all","org_unit_external_ids":["<string>"],"org_unit_filter":"<string>","user_filter":"<string>"}},"source_type":"<string>","status":"<string>","updated_by_email":"<string>","updated_by_name":"<string>"}]
sources[].config_revisioninteger · int64YesConfiguration revision0
sources[].connection_statusstringYesConnection"<string>"
sources[].created_atstring · date-timeYesCreated at"2026-08-27T10:00:00Z"
sources[].created_by_emailstringNoCreator email"<string>"
sources[].created_by_namestringNoCreated by"<string>"
sources[].credential_configuredbooleanYesWhether credentials are configuredfalse
sources[].default_seatbooleanYesRequest seats for new users by defaultfalse
sources[].deletion_alert_emailstringNoAlert email"<string>"
sources[].deletion_alert_enabledbooleanYesDeletion alertfalse
sources[].deletion_alert_thresholdinteger · int64YesDeletion alert threshold0
sources[].deletion_policystringYesOffboarding"<string>"
sources[].external_id_fieldstringYesSource field for the external user ID"<string>"
sources[].external_id_field_lockedbooleanYesWhether the external user ID mapping is lockedfalse
sources[].idstring · uuidYesSource ID"<uuid>"
sources[].last_activity_atstring · date-timeNoLast activity time"2026-08-27T10:00:00Z"
sources[].last_connected_atstring · date-timeNoLast connection time"2026-08-27T10:00:00Z"
sources[].last_connection_error_codestringNoLast connection error code"<string>"
sources[].modified_atstring · date-timeYesUpdated at"2026-08-27T10:00:00Z"
sources[].namestringYesSource name"<string>"
sources[].next_run_atstring · date-timeNoNext sync time"2026-08-27T10:00:00Z"
sources[].schedulestringYesSync frequency"<string>"
sources[].schedule_anchor_atstring · date-timeNoSync time (Beijing time)"2026-08-27T10:00:00Z"
sources[].settingsOpenapifacadeDirectorySourceSettingsYesSource configuration{"connection":{"client_name":"<string>","tls_enabled":false,"url":"<string>"},"department_mapping":{"external_id":"<string>","name":"<string>","order":"<string>","parent_external_id":"<string>","status":"<string>"},"mapping":{"account":"<string>","department_external_id":"<string>","email":"<string>","employee_no":"<string>","external_id":"<string>","name":"<string>","phone":"<string>","status":"<string>"},"scope":{"base_dn":"<string>","mode":"all","org_unit_external_ids":["<string>"],"org_unit_filter":"<string>","user_filter":"<string>"}}
sources[].settings.connectionOpenapifacadeDirectorySourceConnectionYesConnection settings{"client_name":"<string>","tls_enabled":false,"url":"<string>"}
sources[].settings.connection.client_namestringNoSCIM Client"<string>"
sources[].settings.connection.tls_enabledbooleanNoEnable TLSfalse
sources[].settings.connection.urlstringNoServer URL"<string>"
sources[].settings.department_mappingOpenapifacadeDirectorySourceDepartmentMappingYesDepartment mappings{"external_id":"<string>","name":"<string>","order":"<string>","parent_external_id":"<string>","status":"<string>"}
sources[].settings.department_mapping.external_idstringYesExternal department ID (source field)"<string>"
sources[].settings.department_mapping.namestringYesDepartment name (source field)"<string>"
sources[].settings.department_mapping.orderstringNoSort order (source field)"<string>"
sources[].settings.department_mapping.parent_external_idstringNoExternal parent department ID (source field)"<string>"
sources[].settings.department_mapping.statusstringNoStatus (source field)"<string>"
sources[].settings.mappingOpenapifacadeDirectorySourceFieldMappingYesMember mappings{"account":"<string>","department_external_id":"<string>","email":"<string>","employee_no":"<string>","external_id":"<string>","name":"<string>","phone":"<string>","status":"<string>"}
sources[].settings.mapping.accountstringNoAccount (source field)"<string>"
sources[].settings.mapping.department_external_idstringNoExternal department ID for the user's department (source field)"<string>"
sources[].settings.mapping.emailstringNoEmail (source field)"<string>"
sources[].settings.mapping.employee_nostringNoEmployee ID (source field)"<string>"
sources[].settings.mapping.external_idstringYesExternal user ID (source field)"<string>"
sources[].settings.mapping.namestringYesUser name (source field)"<string>"
sources[].settings.mapping.phonestringNoPhone number (source field)"<string>"
sources[].settings.mapping.statusstringNoStatus (source field)"<string>"
sources[].settings.scopeOpenapifacadeDirectorySourceScopeYesSync scope{"base_dn":"<string>","mode":"all","org_unit_external_ids":["<string>"],"org_unit_filter":"<string>","user_filter":"<string>"}
sources[].settings.scope.base_dnstringNoBase DN"<string>"
sources[].settings.scope.modestringYesSync scope type"all"
sources[].settings.scope.org_unit_external_idsarray ｜ nullNoScope departments (external department IDs)["<string>"]
sources[].settings.scope.org_unit_filterstringNoDepartment filter"<string>"
sources[].settings.scope.user_filterstringNoUser filter"<string>"
sources[].source_typestringYesSource type"<string>"
sources[].statusstringYesStatus"<string>"
sources[].updated_by_emailstringNoUpdater email"<string>"
sources[].updated_by_namestringNoUpdated by"<string>"
Response example
default Flat business error
NameTypeRequiredDescriptionExample
codestringNoStable business error code"<string>"
detailstringYesHuman-readable error description"<string>"
detailsOpenapiErrorDetailsNoError details{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstringNoRequest field that failed validation"<string>"
details.reasonstringNoStable validation failure reason"<string>"
details.suggestionstringNoSuggested normalized value"<string>"
errorstringYesStable HTTP error type"<string>"
Response example