1. Development Integration
  2. /
  3. Standard Web Application
  4. /
  5. Node.js
  6. /

  7. Management Module

  8. /

  9. User Management

  10. /
  11. Delete Users

删除用户

Update time: 2025-07-23 07:34:21
Edit

通过用户 ID 列表，删除用户，支持批量删除，可以选择指定用户 ID 类型等。

请求参数

名称类型必填默认值描述示例值
userIdsstring[]是-用户 ID 列表。["userId1","userId2"]
optionsDeleteUsersBatchOptionsDto否-可选参数。

示例代码

import { ManagementClient } from "@genauth/nodejs";
// 在 Node.js 中引用：
// const { ManagementClient } = require('@genauth/nodejs');

const managementClient = new ManagementClient({
  accessKeyId: "GEN_AUTH_USERPOOL_ID",
  accessKeySecret: "GEN_AUTH_USERPOOL_SECRET",
});

(async () => {
  const result = await managementClient.deleteUsersBatch({
    userIds: ["userId1", "userId2"],
    options: {
      userIdType: "user_id",
    },
  });
})();

请求响应

类型： IsSuccessRespDto

名称类型描述
statusCodenumber业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
messagestring描述信息
apiCodenumber细分错误码，可通过此错误码得到具体的错误类型。
dataIsSuccessDto操作是否成功

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "success": true
  }
}

数据结构

DeleteUsersBatchOptionsDto

名称类型必填描述
userIdTypestring否用户 ID 类型，可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值：user_id,external_id,phone,email,username

IsSuccessDto

名称类型必填描述
successboolean是操作是否成功。 示例值： true