Skip to main content

删除目录数据源配置接口

删除指定的通讯录数据源配置,需要提交最新 config_revision。当前处于启用状态的数据源必须先停用,否则服务端拒绝删除。

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

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key,使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
sourceIdpathstring · uuid必填数据源 ID"<uuid>"
Idempotency-Keyheaderstring必填幂等键,用于避免重复提交"<string>"
config_revisionqueryinteger · int64必填配置版本号1

请求示例

curl --request DELETE \
  --url 'https://example.invalid/api/openapi/v1/directory-sync/sources/<sourceId>?config_revision=<config_revision>' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>'

响应

204 No Content

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}