ListWorkspaceRoleUsers - 获取指定空间角色下的用户列表

获取指定空间角色下的用户列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RoleIdlong

空间角色 ID,包括预置角色和自定义角色:

  • 25:空间管理员(预置角色)
  • 26:开发者(预置角色)
  • 27:分析者(预置角色)
  • 30:阅览者(预置角色)
  • 自定义角色:自定义角色对应的角色 ID
25
WorkspaceIdstring

工作空间 ID。

726bee5a-****-43e1-9a8e-b550f0120f35
PageNuminteger

分页查询时的当前页:

  • 起始值:1
  • 默认值:1
1
PageSizeinteger

分页查询时的每页行数:

  • 默认值:10
  • 最大值:1000
10
Keywordstring

用户昵称的关键字。

测试pop用户

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回空间角色下的用户列表。

Dataarray<object>

用户列表。

Dataobject

用户详情。

NickNamestring

组织成员的昵称。

测试用户
UserIdstring

组织成员在 Quick BI 的 UserID。

b5d8fd9348cc4327****afb604
WorkspaceIdstring

工作空间 ID。

7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceNamestring

工作空间名称。

测试空间
PageNuminteger

页码。

1
PageSizeinteger

请求接口时设置的每页行数。

10
TotalNuminteger

总行数。

1
TotalPagesinteger

总页数。

1
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "NickName": "测试用户",
        "UserId": "b5d8fd9348cc4327****afb604\n",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Invalid.WorkspaceThe workspace is not owned by the organization.该空间不在组织内。
400User.Role.NotExistUser role not exist: %s.用户角色不存在:%s。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

访问错误中心查看更多错误码。