获取用户属性值

版本 4.0.23.4

获取指定用户的用户属性值。

返回特定用户的指定用户属性值(或所有用户属性)。

系统会按以下顺序在以下位置搜索每个用户属性的值:

  1. (在用户的帐号信息中)
  2. 用户所属的群组
  3. 用户属性的默认值

如果为某个用户群组定义了多个值,则排名最低的群组胜出。

响应中将仅包含已找到值的用户属性。使用 include_unset=true 为没有值的用户特性添加空记录。

所有隐藏的用户属性的值都将为空。

请求

GET /users/{user_id}/attribute_values
数据类型
说明
请求
HTTP 请求
路径
HTTP 路径
展开 HTTPPath 定义...
user_id
字符串
用户的 ID
查询
HTTPQuery
展开 HTTPQuery 定义...
字段
字符串
请求的字段。
user_attribute_ids
字符串 []
all_values
布尔值
如果为 true,将返回搜索路径中的所有值,而不是仅找到第一个值。这对于调试群组优先级很有用。
include_unset
布尔值
如果为 true,则会针对没有用户、群组或默认值的每个请求属性返回空记录。

响应

200:用户属性的值。

数据类型
说明
(数组)
可以
对象
当前用户可以对此对象执行的操作
name
字符串
用户属性的名称
标签
字符串
方便用户使用的用户属性标签
rank
整数
为用户设置价值的优先级(最低胜出项)
字符串
用户属性的值
user_id
字符串
用户 ID
__修改_用户
布尔值
用户可以设置此值吗
值已隐藏
布尔值
如果值为 true,“值”字段将为 null,因为属性设置禁止访问此值
user_attribute_id
字符串
用户特性 ID
source
字符串
用户如何获得此属性的这个值
隐藏_值_域_白名单
字符串
如果此用户属性处于隐藏状态,则系统可能会将其发送到允许的目标页面列表。

404:未找到

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

示例