QueryUserRoleInfoInWorkspace - 查询工作空间成员的预置角色

获取指定工作空间成员的预置空间角色信息。

调试

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

授权信息

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

请求参数

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

Quick BI 用户 ID。

f5698bedeb384b1986afccd9e434****
WorkspaceIdstring

工作空间 ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

用户的预置空间角色信息。

RoleCodestring

预置角色编码。

role_workspace_admin
RoleIdlong

预置角色 ID。取值范围:

  • 25:空间管理员
  • 26:空间开发者
  • 27:空间分析师
  • 30:空间查看者
25
RoleNamestring

预置角色名称。

空间管理员
Successboolean

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "RoleCode": "role_workspace_admin",
    "RoleId": 25,
    "RoleName": "空间管理员"
  },
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400Workspace.Not.ExistThe group workspace does not exist.群空间不存在。
400User.RoleType.ValidThe role ID is invalid.无效的角色ID。
400User.NotIn.WorkspaceThe user is not a member of the group workspace.该用户不在群空间中。
400User.PresetWorkspaceRole.NotExistUser does not have a predefined workspace role.用户没有预置空间角色。

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

变更历史

变更时间变更内容概要操作
2023-08-07OpenAPI 错误码发生变更查看变更详情