获取自定义用户属性
获取自定义用户属性列表
请求说明
请求地址 | https://openapi.wps.cn/v7/companies/user_custom_attrs/batch_read |
---|---|
请求方法 | GET |
签名方式 | KSO-1 |
权限要求 | 查询和管理用户自定义字段(应用授权) kso.user_custom_attr.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
请求地址示例
[GET] https://openapi.wps.cn/v7/companies/user_custom_attrs/batch_read
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ custom_attrs | array[object] | 用户自定义属性 |
∟ ∟ id | string | 自定义属性 id |
∟ ∟ name | string | 自定义属性名称 |
∟ ∟ value_type | string[enum] | 值类型:text relation_user relation_depts option |
∟ total | integer | 总数 |
响应体示例
json
{
"data": {
"custom_attrs": [
{
"id": "string",
"name": "string",
"value_type": "string[enum]"
}
],
"total": 0
},
"msg": "string",
"code": 0
}