¶ 获取用户、分组、角色、组织机构的自定义字段值

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

通过筛选条件，获取用户、分组、角色、组织机构的自定义字段值。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
targetType	string	是	-	主体类型，目前支持用户、角色、分组、部门。枚举值：`USER`,`ROLE`,`GROUP`,`DEPARTMENT`	`USER`
targetIdentifier	string	是	-	目标对象唯一标志符。	`userId1`
namespace	string	否	-	所属权限分组的 code，当 targetType 为角色的时候需要填写，否则可以忽略。	`default`

¶ 示例代码

import { ManagementClient } from "@genauth/nodejs";
// 在 Node.js 中引用：
// const { ManagementClient } = require('@genauth/nodejs');

const managementClient = new ManagementClient({
  accessKeyId: "GEN_AUTH_USERPOOL_ID",
  accessKeySecret: "GEN_AUTH_USERPOOL_SECRET",
});

(async () => {
  const result = await managementClient.getCustomData({
    targetType: "USER",

    targetIdentifier: "userId1",

    namespace: "default",
  });
})();

¶ 请求响应

类型： GetCustomDataRespDto

名称	类型	描述
statusCode	number	业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
message	string	描述信息
apiCode	number	细分错误码，可通过此错误码得到具体的错误类型。
data	object	具体的自定义数据值

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "age": 18,
    "school": "pku"
  }
}

¶ 数据结构

Previous article: 设置自定义字段的值 Next article: Python