Skip to content

获取自定义用户属性

适用版本>=v7.0.2409b.20240926

接口说明:获取自定义用户属性列表

请求说明

请求地址配置域名+/graph+/v7/companies/user_custom_attrs/batch_read
请求方法GET
签名方式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}

响应体(Response)

名称类型说明
codeintegercode
detailstringdetail
msgstringmsg
dataobject返回信息体
custom_attrsobject[]自定义属性列表
idstring自定义属性 id
namestring自定义属性名称
optionstring自定义字段 type 为 option 时,展示的选项列表
keystringkey 值, 修改 / 新增时作为入参值
namestring显示名
value_typestring自定义属性值类型
totalinteger总数

响应体示例

{
  "data": {
    "custom_attrs": [
      {
        "id": "string",
        "name": "string",
        "options": [
          {
            "key": "string",
            "name": "string"
          }
        ],
        "value_type": "text"
      }
    ],
    "total": 0
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}