1. Development Integration
  2. /
  3. Standard Web Application
  4. /
  5. Java
  6. /

  7. Management Module

  8. /

  9. Custom Field Management

  10. /
  11. Set Custom Field Value

设置自定义字段的值

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

给用户、角色、部门设置自定义字段的值，如果存在则更新，不存在则创建。

请求参数

名称类型必填默认值描述示例值
listSetCustomDataDto[]是-自定义数据列表。
targetIdentifierstring是-主体类型的唯一标志符。如果是用户则为用户 ID，角色为角色的 code，部门为部门的 ID。userId1
targetTypestring是-主体类型，目前支持用户、角色、分组、部门。 枚举值：USER,ROLE,GROUP,DEPARTMENTUSER
namespacestring否-所属权限分组的 code，当 target_type 为角色的时候需要填写，否则可以忽略。default

示例代码

import cn.authing.sdk.java.dto.*;
import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.model.ManagementClientOptions;

class ManagementClientTest {
    private static String ACCESS_KEY_ID = "GEN_AUTH_USERPOOL_ID";
    private static String ACCESS_KEY_SECRET = "GEN_AUTH_USERPOOL_SECRET";

    public static void main(String[] args) {
        ManagementClientOptions clientOptions = new ManagementClientOptions(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        ManagementClient managementClient = new ManagementClient(clientOptions);

        SetCustomDataReqDto request = new SetCustomDataReqDto();
        request.setTargetType(SetCustomDataReqDto.targetType.USER);
        request.setTargetIdentifier("userId1");
        request.setNamespace("default");
            List= new List<SetCustomDataDto>(
                    new SetCustomDataDto().set

               request.setKey("school");
      request.setValue("pku");

                  ),

        IsSuccessRespDto response = managementClient.setCustomData(request);
        System.out.println(response);
    }
}

请求响应

类型： IsSuccessRespDto

名称类型描述
statusCodenumber业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
messagestring描述信息
apiCodenumber细分错误码，可通过此错误码得到具体的错误类型。
dataIsSuccessDto操作是否成功

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "success": true
  }
}

数据结构

SetCustomDataDto

名称类型必填描述
keystring是字段 key，不能和内置字段的 key 冲突。 示例值： school
valuestring是自定义数据，可以为任意类型，但是必须和创建时定义的自定义字段类型匹配，否则将设置失败。 示例值： pku

IsSuccessDto

名称类型必填描述
successboolean是操作是否成功。 示例值： true