设置用户状态

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

  • Scope:admin.v1.user-status.manage
  • 权限项:用户状态管理(user-status)
  • 权限类型:管理
  • 接口:PUT/api/openapi/v1/users/{userId}/status

认证与请求头

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

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

请求参数

名称位置类型必填说明示例
userIdpathstring · uuid必填-"<uuid>"
enabledbodyboolean必填-false

请求示例

cURL

curl --request PUT \
  --url '<BASE_URL>/api/openapi/v1/users/<userId>/status' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": false
}'

响应

200 OK

名称类型必填说明示例
accountstring否-"<string>"
department_idsarray | null是-["<string>"]
emailstring否-"<string>"
job_numberstring否-"<string>"
namestring是-"<string>"
phonestring否-"<string>"
qidstring · uuid是-"<uuid>"
seat_statusstring是-"assigned"
sourcestring是-"manual"
statusstring是-"pending"
updated_atstring · date-time是-"2026-08-27T10:00:00Z"

响应示例

{
  "account": "<string>",
  "department_ids": [
    "<string>"
  ],
  "email": "<string>",
  "job_number": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "qid": "<uuid>",
  "seat_status": "assigned",
  "source": "manual",
  "status": "pending",
  "updated_at": "2026-08-27T10:00:00Z"
}

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