1. Development Integration
  2. /
  3. SDK
  4. /
  5. Java
  6. /

  7. Management module

  8. /

  9. Manage users

  10. /
  11. Set user department

Set the user's department

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

This document is automatically generated based on https://github.com/authing/authing-docs-factory and 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

NameType
Is it required
Default Value
Description
Example Value
departmentsSetUserDepartmentDto[]Yes-Department information Array length limit: 50.[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]
userIdstringYes-Unique identifier of the user, can be user ID, user name, email, phone number, externalId, ID in external identity source, see the description of userIdType field for details. The default is user id.6229ffaxxxxxxxxcade3e3d9
optionsSetUserDepartmentsOptionsDtoNo-Optional parameters

Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.IsSuccessRespDto;
import cn.authing.sdk.java.dto.SetUserDepartmentDto;
import cn.authing.sdk.java.dto.SetUserDepartmentsDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

import java.util.ArrayList;
import java.util.List;

public class SetUserDepartmentsTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");

        ManagementClient client = new ManagementClient(clientOptions);

        SetUserDepartmentsDto reqDto = new SetUserDepartmentsDto();
        List<SetUserDepartmentDto> list = new ArrayList<>();
        SetUserDepartmentDto departmentDto = new SetUserDepartmentDto();
        departmentDto.setDepartmentId("SetUserDepartmentDto()");
        list.add(departmentDto);
        reqDto.setDepartments(list);
        reqDto.setUserId("6229ffaxxxxxxxxcade3e3d9");
        IsSuccessRespDto response = client.setUserDepartments(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

Request Response

Type： IsSuccessRespDto

NameTypeDescription
statusCodenumberBusiness status code. You can use this status code to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegment error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see：API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.
dataIsSuccessDtoWhether the operation is successful

Example Results：

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

Data Structure

SetUserDepartmentDto

NameType
Is it required
Description
Example Value
departmentIdstringYesdepartment id60b49eb83fd80adb96f26e68
isLeaderbooleanNoYes No Yes department leadertrue
isMainDepartmentbooleanNoYes No Yes main departmenttrue

SetUserDepartmentsOptionsDto

NameType
Is it required
Description
Example Value
userIdTypestringNoUser 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 user's ID 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

NameType
Is it required
Description
Example Value
successbooleanYesWhether the operation is successfultrue