删除用户接口

更新时间:
复制 MD 格式

所需权限

所需权限

资源

Scope

资源服务

用户与部门管理(管理)

user-directory

admin.v1.user-directory.manage

qwenwork-biz-service

DELETE /api/openapi/v1/users/{userId}

公共请求头

适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。

Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。

请求参数

名称

位置

类型

必填

说明

示例

userId

path

string · uuid

是

用户 ID

"<uuid>"

Idempotency-Key

header

string

是

幂等键,用于避免重复提交

"<string>"

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request DELETE \
  --url '<BASE_URL>/api/openapi/v1/users/<userId>' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>'

响应状态表

本表描述业务服务返回;网关自行生成的响应以网关契约为准,本轮未验证部署网关返回。

HTTP 状态码

触发条件

响应结构引用

客户端处理建议

204

删除成功

无响应体

无需解析正文。

400

请求或依赖请求被拒绝

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

检查 code 与请求,不原样重试。

401

认证信息缺失或无效

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

核对凭据后重试。

403

Scope、授权范围或准入条件不满足

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

核对权限与目标资源。

404

目标用户或关联资源不存在

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

核对资源 ID 和当前状态。

409

业务状态或唯一字段冲突

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

按 code 和详情处理冲突,再决定是否重试。

422

参数或业务校验失败

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

修正参数后重试。

503

依赖不可用或写入后的同步尚未确认

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构; 见本文“已提交与同步恢复”

先查询当前状态;仅有 committed=true 才确认已提交,按恢复信息处理。

default

其他未单列的业务服务错误

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

保留状态码、code 与请求标识;不要推断已提交或已回滚。

Cache-Control: no-store。

响应结果

无响应体。HTTP 状态码:204.

特殊响应

已提交与同步恢复

复用结构:见《通过 API 配置 QwenWork 管理后台》的“公共错误字段”结构

仅在 details.committed=true 时使用。recovery 与 results 至少有一项;两者可以同时存在。没有该详情的 503 不证明写入已提交或回滚。

名称

类型

必填

说明

示例

code

string

是

该分支必有的业务错误码。 取值:"iam_openapi_execution_unavailable"

"iam_openapi_execution_unavailable"

details

object

是

仅在该错误分支有结构化详情时出现。

-

details

至少包含字段:recovery / results

字段

类型

必填

说明

committed

boolean

是

固定为 true:本地写入已提交,不代表同步成功。 取值:true

recovery

object

否

总体或该用户的同步恢复信息。

results

array

否

逐用户同步结果;可与总体 recovery 同时存在。

details.recovery

字段

类型

必填

说明

automatic_retry

boolean

是

是否由系统自动重试。

next_retry_at

string · date-time

否

下次重试时间;未安排时省略。

requires_action

boolean

是

是否需要调用方或管理员处理。

state

string

是

恢复状态:succeeded、processing、retrying、action_required、unconfirmed。 取值:"action_required"、"processing"、"retrying"、"succeeded"、"unconfirmed"

details.results[]

字段

类型

必填

说明

code

string

否

稳定业务错误码;没有业务码时可省略。

recovery

object

是

总体或该用户的同步恢复信息。

user_id

string

是

本条同步结果的用户 ID。

details.results[].recovery

复用结构:见本文“details.recovery”

用户写入等待与重试规则见API 首页“错误处理”中的“用户写入的同步等待与重试”。

响应示例 — 503

{
  "error": "Service Unavailable",
  "detail": "The write was saved; synchronization is pending.",
  "code": "iam_openapi_execution_unavailable",
  "details": {
    "committed": true,
    "recovery": {
      "state": "processing",
      "automatic_retry": false,
      "requires_action": false
    }
  }
}