Set the user's 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.

Set the user's department through the user ID, and you can choose to specify the user ID type, etc.

Method name

ManagementClient.setUserDepartments

Request parameters

Name	Type	Required	Default value	Description	Sample value
departments	<a SetUserDepartmentDto[]	Yes	-	Department information Array length limit: 50.	[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]
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
options	<a SetUserDepartmentsOptionsDto	No	-	Optional parameters

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.setUserDepartments({
    // Replace user ID
    userId: "6229ffaxxxxxxxxcade3e3d9",
    departments: [
      {
        departmentId: "60b49eb83fd80adb96f26e68",
        isLeader: true,
        isMainDepartment: true,
      },
    ],
    options: {
      userIdType: Models.SetUserDepartmentsOptionsDto.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 (successful request is not returned). For a detailed list of error codes, please 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

SetUserDepartmentDto

Name	Type	Is it required	Description	Sample value
departmentId	string	yes	department id	60b49eb83fd80adb96f26e68
isLeader	boolean	no	is it the department leader	true
isMainDepartment	boolean	no	is it the main department	true

SetUserDepartmentsOptionsDto

| Name | Type | Is it required | Description | Sample 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: username
- 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 |

IsSuccessDto

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