Resigned 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.

Resigned users. The resignation operation will perform the following operations:

• After resignation, the member's authorization, department, role, group, and position relationship will be deleted;
• After resignation, the user's basic information will be retained, and the account will be disabled and unable to log in to the application; if you need to completely delete the account, please call the deletion interface.

This operation cannot be recovered, please operate with caution!

Method name

ManagementClient.resignUser

Request Parameters

Name	Type	Is it required?	Default value	Description	Sample value
userId	string	yes	-	The unique identifier of the user, which can be user ID, user name, email, phone number, externalId, or ID in an external identity source. For details, see the description of the userIdType field. The default is user id.	6229ffaxxxxxxxxcade3e3d9
userIdType	string	No	user_id	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 user's ID in the external identity source. Example value: lark:ou_8bae746eac07cd2564654140d2a9ac61.	user_id

Example Code

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

// Init 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 you are 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.resignUser({
    // Replace User ID
    userId: "6229ffaxxxxxxxxcade3e3d9",
    userIdType: Models.ResignUserReqDto.userIdType.USER_ID,
  });

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

Request Response

type: ResignUserRespDto

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 (successful request does not return). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a ResignUserDataDto	Response data

Sample result:

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

Data Structure

ResignUserDataDto

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