批量获取用户的自定义属性值
适用版本>=v7.0.2409b.20240926
接口说明:批量获取用户的自定义属性值
请求说明
| 请求地址 | 配置域名+/graph+/v7/users/custom_attrs/batch_read |
|---|---|
| 请求方法 | POST |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 查询和管理用户自定义字段(企业授权) kso.user_custom_attr.readwrite |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间,示例: Wed,23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| user_ids | string[] | 是 | 用户id列表,列表长度最大为50 |
请求体示例
{
"user_ids": ["string"]
}响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | 返回信息体 |
| ∟ users | object[] | 用户列表 |
| ∟ ∟ custom_attrs | object[] | 自定义属性列表 |
| ∟ ∟ ∟ attr_id | string | 自定义属性 id |
| ∟ ∟ ∟ attr_name | string | 自定义属性名称 |
| ∟ ∟ ∟ attr_value_type | string | 自定义属性值类型 |
| ∟ ∟ ∟ option | string | 自定义字段 type 为 option 时,展示的选项列表 |
| ∟ ∟ ∟ relation_depts | string[] | 自定义字段 type 为 relation_depts 时,展示的选项列表 |
| ∟ ∟ ∟ relation_user | string | 自定义字段 type 为 relation_user 时,展示的选项列表 |
| ∟ ∟ ∟ text | string | 自定义字段 type 为 text 时,展示的选项列表 |
| ∟ ∟ ∟ url | object | 自定义字段 type 为 url 时,展示的选项列表 |
| ∟ ∟ ∟ ∟ ∟ title | string | 标题 |
| ∟ ∟ ∟ ∟ ∟ link | string | 链接 |
| ∟ ∟ user_id | string | 用户 id |
响应体示例
{
"data": {
"users": [
{
"custom_attrs": [
{
"attr_id": "string",
"attr_name": "string",
"attr_value_type": "string",
"option": "string",
"relation_depts": ["string"],
"relation_user": "string",
"text": "string"
"url": {
"title": "string",
"link": "string"
}
}
],
"user_id": "string"
}
]
},
"msg": "string",
"code": 0
}