一、应用场景用户拓展属性是提供给企业自定义用户信息的功能。物联云平台用户信息仅提供基础信息,在无法满足企业业务需求时,可以通过用户拓展属性添加企业需要的新信息。添加用户拓展属性后,则仅限该用户会具有此拓展属性。
企业添加用户新的拓展属性。
用户设置个人的拓展属性信息。
二、功能说明企业在添加用户拓展属性时,需要设置该用户拓展属性的键值。支持修改和删除用户的拓展属性。修改用户拓展属性时,必须是该用户已有的拓展属性。
三、前提条件1.单个用户拓展属性最多允许存在50个。
四、关键流程4.1 用户拓展属性管理流程说明:
首先,C端APP用户登录到物联网中台,获取到物联网中台的调用凭证以及刷新凭证。
其次,C端APP用户根据功能场景向物联网中台发起 保存用户拓展属性 /修改用户拓展属性/获取用户拓展属性/获取用户单个拓展属性/删除用户单个拓展属性 等请求。
最后,物联网中台接收C端APP用户发起的请求,依据不同请求类型进行不同的业务逻辑处理,返回不同的用户拓展属性数据。
五、API列表5.1 用户拓展属性5.1.1 保存用户扩展属性接口描述
企业成员或者企业用户添加或者修改用户的拓展属性,拓展属性最多50个;企业成员可以添加修改企业下所有用户的拓展属性,企业用户只能添加更新自己的拓展属性;由于历史原因,该接口并无固定参数
请求方式
POST
请求地址
/v2/user/{user_id}/property
请求头
名称
必填
类型
备注
Access-Token
true
String
调用凭证企业成员企业用户
Content-Type
true
String
application/json
请求参数
名称
位置
必填
类型
备注
user_id
path
true
Int
用户标识
key1
body
true
String
拓展属性键,该键并不固定,可根据用户需求进行定义;且个数也不固定
请求示例:
{
"key-name": "物联云平台"
}
返回参数说明
名称
必填
类型
备注
key1
true
String
拓展属性键,该键并不固定,可根据用户需求进行定义;且个数也不固定
返回示例:
{
"key-name": "物联云平台"
}
错误码:
错误码
描述
4001001
请求数据字段验证不通过
4001002
请求数据必须字段不可为空
4031001
调用凭证权限被禁止访问
4031003
无效的调用凭证
4031002
需要调用凭证
4041001
接口不存在
5031001
系统错误
4031024
权限不足
4001024
设备扩展属性超过上限
4041011
用户不存在
5.1.2 修改用户扩展属性接口描述
企业成员或者企业用户修改用户的拓展属性,拓展属性最多50个;企业成员可以修改企业下所有用户的拓展属性,企业用户只能修改自己的拓展属性;由于历史原因,该接口并无固定参数,但必须是用户已有的拓展属性
请求方式
PUT
请求地址
/v2/user/{user_id}/property
请求头
名称
必填
类型
备注
Access-Token
true
String
调用凭证企业成员企业用户
Content-Type
true
String
application/json
请求参数
名称
位置
必填
类型
备注
user_id
path
true
Int
用户标识
key1
body
true
String
拓展属性键,该键并不固定,可根据用户需求进行定义;且个数也不固定;但必须是用户已有的拓展属性
请求示例:
{
"key-name": "李清华"
}
返回参数说明
名称
必填
类型
备注
key1
true
String
拓展属性键,该键并不固定,可根据用户需求进行定义;且个数也不固定;但必须是用户已有的拓展属性
返回示例:
{
"key-name": "李清华"
}
错误码:
错误码
描述
4001001
请求数据字段验证不通过
4001002
请求数据必须字段不可为空
4031001
调用凭证权限被禁止访问
4031003
无效的调用凭证
4031002
需要调用凭证
4041001
接口不存在
5031001
系统错误
4031024
权限不足
4001024
设备扩展属性超过上限
4041011
用户不存在
4001026
用户拓展属性不存在
5.1.3 获取用户扩展属性接口描述
企业成员或者企业用户获取用户的拓展属性;企业成员可以获取企业下所有用户的拓展属性,企业用户只能获取自己的拓展属性;
请求方式
GET
请求地址
/v2/user/{user_id}/property
请求头
名称
必填
类型
备注
Access-Token
true
String
调用凭证企业成员企业用户
Content-Type
true
String
application/json
请求参数
名称
位置
必填
类型
备注
user_id
path
true
Int
用户标识
请求示例:
{
}
返回参数说明
名称
必填
类型
备注
key1
true
String
拓展属性键,该键并不固定,可根据用户需求进行定义;且个数也不固定;
返回示例:
{
"key-name": "李清华"
}
错误码:
错误码
描述
4001001
请求数据字段验证不通过
4001002
请求数据必须字段不可为空
4031001
调用凭证权限被禁止访问
4031003
无效的调用凭证
4031002
需要调用凭证
4041001
接口不存在
5031001
系统错误
4031024
权限不足
4041011
用户不存在
5.1.4 获取用户单个扩展属性接口描述
企业成员或者企业用户获取用户的单个拓展属性;企业成员可以获取企业下所有用户的单个拓展属性,企业用户只能获取自己的单个拓展属性;
请求方式
GET
请求地址
/v2/user/{user_id}/property/{key}
请求头
名称
必填
类型
备注
Access-Token
true
String
调用凭证企业成员企业用户
Content-Type
true
String
application/json
请求参数
名称
位置
必填
类型
备注
user_id
path
true
Int
用户标识
key
path
true
String
属性键
请求示例:
{
}
返回参数说明
名称
必填
类型
备注
key1
true
String
拓展属性键,该键并不固定,可根据用户需求进行定义;
返回示例:
{
"key-name": "李清华"
}
错误码:
错误码
描述
4001001
请求数据字段验证不通过
4001002
请求数据必须字段不可为空
4031001
调用凭证权限被禁止访问
4031003
无效的调用凭证
4031002
需要调用凭证
4041001
接口不存在
5031001
系统错误
4031024
权限不足
4041011
用户不存在
5.1.5 删除用户单个扩展属性接口描述
企业成员或者企业用户删除用户的单个拓展属性;企业成员可以删除企业下所有用户的单个拓展属性,企业用户只能删除自己的单个拓展属性;
请求方式
DELETE
请求地址
/v2/user/{user_id}/property/{key}
请求头
名称
必填
类型
备注
Access-Token
true
String
调用凭证企业成员企业用户
Content-Type
true
String
application/json
请求参数
名称
位置
必填
类型
备注
user_id
path
true
Int
用户标识
key
path
true
String
属性键
请求示例:
{
}
返回参数说明
名称
必填
类型
备注
无
无
无
无
返回示例:
{
}
错误码:
错误码
描述
4001001
请求数据字段验证不通过
4001002
请求数据必须字段不可为空
4031001
调用凭证权限被禁止访问
4031003
无效的调用凭证
4031002
需要调用凭证
4041001
接口不存在
5031001
系统错误
4031024
权限不足
4041011
用户不存在
上次更新:2025-05-26