获取自定义用户属性
适用版本>=v7.0.2412a.20241212
接口说明:获取自定义用户属性列表
请求说明
| 请求地址 | 配置域名+/openapi+/v7/companies/user_custom_attrs/batch_read |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询和管理用户自定义字段(应用授权) kso.user_custom_attr.readwrite |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | 返回信息体 |
| ∟ custom_attrs | object[] | 自定义属性列表 |
| ∟ ∟ id | string | 自定义属性 id |
| ∟ ∟ name | string | 自定义属性名称 |
| ∟ ∟ option | string | 自定义字段 type 为 option 时,展示的选项列表 |
| ∟ ∟ ∟ key | string | key 值, 修改 / 新增时作为入参值 |
| ∟ ∟ ∟ name | string | 显示名 |
| ∟ ∟ value_type | string | 自定义属性值类型 |
| ∟ total | integer | 总数 |
响应体示例
json
{
"data": {
"custom_attrs": [
{
"id": "string",
"name": "string",
"options": [
{
"key": "string",
"name": "string"
}
],
"value_type": "text"
}
],
"total": 0
},
"code": 0,
"detail": "string",
"msg": "string"
}