获取指定组织角色下的用户列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:ListOrganizationRoleUsers |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RoleId |
integer |
是 |
组织角色 ID,包括预置角色和自定义角色:
|
111111111 |
| PageNum |
integer |
否 |
页码。
|
1 |
| PageSize |
integer |
否 |
每页行数。
|
10 |
| Keyword |
string |
否 |
组织成员昵称的关键字。 |
小刘 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
BCE45E6D-9304-4F94-86BB-5A772B1615FF |
| Result |
object |
返回组织角色下的用户列表。 |
|
| Data |
array<object> |
用户列表。 |
|
|
object |
用户详情。 |
||
| NickName |
string |
组织成员的昵称。 |
测试用户 |
| UserId |
string |
组织成员在 Quick BI 的 UserID。 |
b5d8fd9348cc4327****afb604 |
| PageNum |
integer |
页码。 |
10 |
| PageSize |
integer |
请求接口时设置的每页行数。 |
1 |
| TotalNum |
integer |
总行数。 |
10 |
| TotalPages |
integer |
总页数。 |
1 |
| Success |
boolean |
是否请求成功。取值范围:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "BCE45E6D-9304-4F94-86BB-5A772B1615FF",
"Result": {
"Data": [
{
"NickName": "测试用户",
"UserId": "b5d8fd9348cc4327****afb604"
}
],
"PageNum": 10,
"PageSize": 1,
"TotalNum": 10,
"TotalPages": 1
},
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | User.Role.NotExist | User role not exist: %s. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。