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

  7. Management module

  8. /

  9. Manage custom fields

  10. /
  11. Get custom field values ​​for users, groups, roles, and organizations

Get custom field values ​​for users, groups, roles, and organizations

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

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

Get custom field values ​​for users, groups, roles, and organizations by filtering conditions.

Method Name

ManagementClient.getCustomData

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
targetIdentifierstringYes-Unique identifier of the target object:
- If Yes user, the user's ID, such as 6343b98b7cfxxx9366e9b7c
- If Yes role, the role's code, such as admin
- If Yes group, the group's code, such as developer
- If Yes department, the department's ID, such as 6343bafc019xxxx889206c4c
userId1
targetTypestringYes-Target object Type:
- USER: user
- ROLE: role
- GROUP: group
- DEPARTMENT: department
USER
tenantIdstringYes-Tenant ID642c1df417c2d8a80d744c1d
namespacestringNo-The code of the permission group. This field is required when targetType is role. If this field is No, it can be ignored.default

Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.GetCustomDataDto;
import cn.authing.sdk.java.dto.GetCustomDataRespDto;
import cn.authing.sdk.java.dto.TargetDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class GetCustomDataTest {
    // 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);

        GetCustomDataDto reqDto = new GetCustomDataDto();
        reqDto.setTargetType(TargetDto.TargetType.USER.getValue());
        reqDto.setTargetIdentifier("6343b98b7cfxxx9366e9b7c");
        GetCustomDataRespDto response = client.getCustomData(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

Request Response

Type： GetCustomDataRespDto

NameTypeDescription
statusCodenumberBusiness status code, which can be used to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegmented 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 (opens new window)
requestIdstringRequest ID. Returned when the request fails.
dataobjectSpecific custom data value

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "age": 18,
    "school": "pku"
  }
}

Data Structure