¶ 删除用户
更新时间: 2024-10-10 07:28:40
通过用户 ID 列表，删除用户，支持批量删除，可以选择指定用户 ID 类型等。
¶ 请求参数
| 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 |
|---|---|---|---|---|---|
| userIds | array[] | 是 | - | 用户 ID 列表。 | ["userId1","userId2"] |
| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 |
¶ 示例代码
from authing import ManagementClient
management_client = ManagementClient(
access_key_id="AUTHING_USERPOOL_ID",
access_key_secret="AUTHING_USERPOOL_SECRET",
)
data = management_client.delete_users_batch(
user_ids: ["userId1","userId2"],
options: {
user_id_type: "user_id",
},
)
¶ 请求响应
类型： IsSuccessRespDto
| 名称 | 类型 | 描述 |
|---|---|---|
| statusCode | number | 业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。 |
| message | string | 描述信息 |
| apiCode | number | 细分错误码，可通过此错误码得到具体的错误类型。 |
| data | IsSuccessDto | 操作是否成功 |
示例结果：
{
"statusCode": 200,
"message": "操作成功",
"apiCode": 20001,
"data": {
"success": true
}
}
¶ 数据结构
¶ DeleteUsersBatchOptionsDto
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| userIdType | string | 否 | 用户 ID 类型，可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值：user_id,external_id,phone,email,username |
¶ IsSuccessDto
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| success | boolean | 是 | 操作是否成功。 示例值： true |