保存目录数据源配置接口

将 <BASE_URL> 替换为所在企业环境的 API 域名。

  • Scope:admin.v1.directory-sync-config.manage
  • 权限项:用户同步配置管理(directory-sync-config)
  • 权限类型:管理
  • 接口:PUT/api/openapi/v1/directory-sync/sources/{sourceId}

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。

名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key,使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
sourceIdpathstring · uuid必填-"<uuid>"
Idempotency-Keyheaderstring必填-"<string>"
config_revisionbodyinteger · int64否-1
credentialsbodyOpenapifacadeDirectorySourceCredentials否-{"agent_id":"<string>","app_id":"<string>","app_secret":"<string>","bind_dn":"<string>","bind_password":"<string>","client_id":"<string>","client_secret":"<string>","corp_id":"<string>","secret":"<string>","tenant_id":"<string>"}
default_seatbodyboolean必填-false
deletion_alert_emailbodystring否-"<string>"
deletion_alert_enabledbodyboolean必填-false
deletion_alert_thresholdbodyinteger · int64必填-0
deletion_policybodystring必填-"delete_user"
initial_scim_tokenbodystring否-"<string>"
namebodystring必填-"<string>"
schedulebodystring必填-"manual"
schedule_anchor_atbodystring · date-time否-"2026-08-27T10:00:00Z"
settingsbodyOpenapifacadeDirectorySourceSettings必填-{"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_typebodystring必填-"dingtalk"

请求示例

cURL

curl --request PUT \
  --url '<BASE_URL>/api/openapi/v1/directory-sync/sources/<sourceId>' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
  "config_revision": 1,
  "credentials": {
    "agent_id": "<string>",
    "app_id": "<string>",
    "app_secret": "<string>",
    "bind_dn": "<string>",
    "bind_password": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "corp_id": "<string>",
    "secret": "<string>",
    "tenant_id": "<string>"
  },
  "default_seat": false,
  "deletion_alert_email": "<string>",
  "deletion_alert_enabled": false,
  "deletion_alert_threshold": 0,
  "deletion_policy": "delete_user",
  "initial_scim_token": "<string>",
  "name": "<string>",
  "schedule": "manual",
  "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": "dingtalk"
}'

响应

200 OK

名称类型必填说明示例
config_revisioninteger · int64是-0
connection_statusstring是-"<string>"
created_atstring · date-time是-"2026-08-27T10:00:00Z"
created_by_emailstring否-"<string>"
created_by_namestring否-"<string>"
credential_configuredboolean是-false
default_seatboolean是-false
deletion_alert_emailstring否-"<string>"
deletion_alert_enabledboolean是-false
deletion_alert_thresholdinteger · int64是-0
deletion_policystring是-"<string>"
external_id_fieldstring是-"<string>"
external_id_field_lockedboolean是-false
idstring · uuid是-"<uuid>"
last_activity_atstring · date-time否-"2026-08-27T10:00:00Z"
last_connected_atstring · date-time否-"2026-08-27T10:00:00Z"
last_connection_error_codestring否-"<string>"
modified_atstring · date-time是-"2026-08-27T10:00:00Z"
namestring是-"<string>"
next_run_atstring · date-time否-"2026-08-27T10:00:00Z"
schedulestring是-"<string>"
schedule_anchor_atstring · date-time否-"2026-08-27T10:00:00Z"
settingsOpenapifacadeDirectorySourceSettings是-{"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>"}}
settings.connectionOpenapifacadeDirectorySourceConnection是-{"client_name":"<string>","tls_enabled":false,"url":"<string>"}
settings.connection.client_namestring否-"<string>"
settings.connection.tls_enabledboolean否-false
settings.connection.urlstring否-"<string>"
settings.department_mappingOpenapifacadeDirectorySourceDepartmentMapping是-{"external_id":"<string>","name":"<string>","order":"<string>","parent_external_id":"<string>","status":"<string>"}
settings.department_mapping.external_idstring是-"<string>"
settings.department_mapping.namestring是-"<string>"
settings.department_mapping.orderstring否-"<string>"
settings.department_mapping.parent_external_idstring否-"<string>"
settings.department_mapping.statusstring否-"<string>"
settings.mappingOpenapifacadeDirectorySourceFieldMapping是-{"account":"<string>","department_external_id":"<string>","email":"<string>","employee_no":"<string>","external_id":"<string>","name":"<string>","phone":"<string>","status":"<string>"}
settings.mapping.accountstring否-"<string>"
settings.mapping.department_external_idstring否-"<string>"
settings.mapping.emailstring否-"<string>"
settings.mapping.employee_nostring否-"<string>"
settings.mapping.external_idstring是-"<string>"
settings.mapping.namestring是-"<string>"
settings.mapping.phonestring否-"<string>"
settings.mapping.statusstring否-"<string>"
settings.scopeOpenapifacadeDirectorySourceScope是-{"base_dn":"<string>","mode":"all","org_unit_external_ids":["<string>"],"org_unit_filter":"<string>","user_filter":"<string>"}
settings.scope.base_dnstring否-"<string>"
settings.scope.modestring是-"all"
settings.scope.org_unit_external_idsarray | null否-["<string>"]
settings.scope.org_unit_filterstring否-"<string>"
settings.scope.user_filterstring否-"<string>"
source_typestring是-"<string>"
statusstring是-"<string>"
updated_by_emailstring否-"<string>"
updated_by_namestring否-"<string>"

响应示例

{
  "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>"
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否-{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring否Request field that failed validation"<string>"
details.reasonstring否Stable validation failure reason"<string>"
details.suggestionstring否Suggested normalized value"<string>"
errorstring是Stable HTTP error type"<string>"

响应示例

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}