删除成员

将指定成员从企业中删除。

所需权限

users:delete

请求说明

请求方式：DELETE
请求地址：{域名}/openapi/v1/users

注意事项

当企业成员由外部身份源（包括火山引擎云身份中心）统一管理时，请求将失败，不会删除成员。

请求参数

参数	类型	是否必填	描述
`user_ids`	string[]	条件必填	待删除成员的 ID，最多 100 个。
`emails`	string[]	条件必填	待删除成员的邮箱，最多 100 个。

提示

user_ids 和 emails 参数只需提供其中一个。

由于 user_ids 的优先级高于 emails，若同时传入两个参数，emails 会被忽略。

响应参数

参数	类型	描述
`success_count`	int	成功删除的成员数量。
`failed_items`	array	删除失败的成员列表。

failed_items[] 数组包含以下参数：

参数	类型	描述
`email`	string	删除失败的成员邮箱（即请求中传入的原始值）。
`code`	int	错误码。
`message`	string	失败原因。

请求示例

{
  "user_ids": [123, 456],
  "emails": ["a@test.com", "b@test.com"]
}

响应示例

{
  "code": 0,
  "message": "success",
  "request_id": "req_abc123xyz",
  "data": {
    "success_count": 2,
    "failed_items": [
      {
        "email": "notexist@example.com",
        "code": 30007,
        "message": "user not found"
      }
    ]
  }
}

文档对您有帮助吗?