Batch delete users

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If this document description is incorrect, please refer to V3 API.

Delete users through user ID list, support batch deletion, and can choose to specify user ID type, etc.

Method name

ManagementClient.deleteUsersBatch

Request parameters

Name	Type	Required	Default value	Description	Sample value
userIds	string[]	Yes	-	User ID list Array length limit: 50.	["userId1","userId2"]
options	<a DeleteUsersBatchOptionsDto	No	-	Optional parameters	{"userIdType":"user_id"}

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.deleteUsersBatch({
    // Replace user ID array
    userIds: ["6229ffaxxxxxxxxcade3e3d9"],
    options: {
      userIdType: Models.DeleteUsersBatchOptionsDto.userIdType.USER_ID,
    },
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request response

Type: IsSuccessRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	description
apiCode	number	Segmented error code, which can be used to get the specific error type (not returned for successful requests). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a IsSuccessDto	Whether the operation is successful

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "success": true
  }
}

Data structure

DeleteUsersBatchOptionsDto

Name	Type	Is it required	Description	Example value
userIdType	string	No	User ID type, the default value is user_id, the optional values are: - user_id: GenAuth user ID, such as 6319a1504f3xxxxf214dd5b7 - phone: user phone number - email: user email - username: user name - external_id: user ID in the external system, corresponding to the externalId field of GenAuth user information - identity: user's external identity source information, the format is <extIdpId>:<userIdInIdp>, where <extIdpId> is the ID of the GenAuth identity source, and <userIdInIdp> is the ID of the user in the external identity source. Example value: 62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61. - sync_relation: The user's external identity source information, in the format of <provier>:<userIdInIdp>, where <provier> is the synchronization identity source type, such as wechatwork, lark; <userIdInIdp> is the ID of the user in the external identity source. Example value: lark:ou_8bae746eac07cd2564654140d2a9ac61.	user_id

IsSuccessDto

Name	Type	Is it required	Description	Example value
success	boolean	yes	Whether the operation was successful	true