查询与组织相关的用户关联关系
功能介绍
应用服务器可调用此接口查询与组织相关的用户关联关系。
URI
GET /v1/iotfm/organizations/{organization_id}/user-associations
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
organization_id |
是 |
String |
参数说明:组织ID。 取值范围:长度固定24,只允许大小写字母、数字的组合。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数说明:用户Token。通过调用 生成Token 接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
X-Instance-Id |
是 |
String |
参数说明:实例ID。通过访问智能设施云平台界面后获取,智能设施云平台资源均为实例级隔离,所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围:长度8-36,只允许大小写字母、数字和-字符的组合。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
user_associations |
Array of UserAssociation objects |
参数说明:关联关系。 取值范围:长度0-50。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
参数说明:被关联的用户ID。 取值范围:长度固定1-64,只允许大小写字母、数字以及_-等符号的组合。 |
user_name |
String |
参数说明:被关联的用户名。 取值范围:长度4-32,要求大小写字母开头,只允许大小写字母、数字以及_.-等符号的组合。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数说明:错误码。 取值范围:长度8-36。 |
error_msg |
String |
参数说明:错误描述。 取值范围:长度2-512。 |
请求示例
查询与组织相关的用户关联关系
GET https://{endpoint}/v1/iotfm/organizations/abcdefaaaaaaaaaaaaaaaaaaaa/user-associations
响应示例
状态码:200
OK
{ "user_associations" : [ { "user_id" : "abcdefaaaaaaaaaaaaaaaaaaaa", "user_name" : "demo-username" }, { "user_id" : "abcdefaaaaaaaaaaaaaaaaaaa1", "user_name" : "demo-username1" }, { "user_id" : "abcdefaaaaaaaaaaaaaaaaaaa2", "user_name" : "demo-username2" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Error response |