Add members to a department

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.

Add members to a department by department ID and organization code.

Method name

ManagementClient.addDepartmentMembers

Request parameters

Name	Type	Required	Default value	Description	Sample value
userIds	string[]	yes	-	User ID list	["623c20b2a062aaaaf41b17da"]
organizationCode	string	yes	-	Organization code	steamory
departmentId	string	yes	-	Department system ID (automatically generated by the GenAuth system, cannot be modified)	60b49eb83fd80adb96f26e68
departmentIdType	string	No	department_id	The type of department ID used in this call	department_id
tenantId	string	No	-	Tenant ID	623c20b2a062aaaaf41b17da

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 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.addDepartmentMembers({
    // Replace organization code and department ID
    departmentId: "60b49eb8xxxxxxdb96f26e68",
    organizationCode: "steamory",
    departmentIdType:
      Models.AddDepartmentMembersReqDto.departmentIdType.DEPARTMENT_ID,
    // Replace user ID array
    userIds: ["623c20b2xxxxxxaaf41b17da"],
  });

  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 (successful requests are not returned). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. It will be 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

IsSuccessDto

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