¶ 设置自定义字段的值
更新时间: 2024-10-10 07:28:40
给用户、角色、部门设置自定义字段的值，如果存在则更新，不存在则创建。
¶ 请求参数
| 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 |
|---|---|---|---|---|---|
| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 | |
| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID，角色为角色的 code，部门为部门的 ID。 | userId1 |
| targetType | string | 是 | - | 主体类型，目前支持用户、角色、分组、部门。 枚举值：USER,ROLE,GROUP,DEPARTMENT | USER |
| namespace | string | 否 | - | 所属权限分组的 code，当 target_type 为角色的时候需要填写，否则可以忽略。 | default |
¶ 示例代码
<?php
require 'vendor/autoload.php';
use Authing\ManagementClient;
$management = new ManagementClient(
"AUTHING_USERPOOL_ID",
"AUTHING_USERPOOL_SECRET"
);
$data = $management->setCustomData(array(
"targetType" => "USER",
"targetIdentifier" => "userId1",
"namespace" => "default",
"list" => array(
array(
"key" => "school",
"value" => "pku",
)
),
));
¶ 请求响应
类型： IsSuccessRespDto
| 名称 | 类型 | 描述 |
|---|---|---|
| statusCode | number | 业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。 |
| message | string | 描述信息 |
| apiCode | number | 细分错误码，可通过此错误码得到具体的错误类型。 |
| data | IsSuccessDto | 操作是否成功 |
示例结果：
{
"statusCode": 200,
"message": "操作成功",
"apiCode": 20001,
"data": {
"success": true
}
}
¶ 数据结构
¶ SetCustomDataDto
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| key | string | 是 | 字段 key，不能和内置字段的 key 冲突。 示例值： school |
| value | string | 是 | 自定义数据，可以为任意类型，但是必须和创建时定义的自定义字段类型匹配，否则将设置失败。 示例值： pku |
¶ IsSuccessDto
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| success | boolean | 是 | 操作是否成功。 示例值： true |