AddUserToWorkspace - 添加成员到工作空间

更新时间:
复制为 MD 格式

添加成员到指定工作空间。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:AddUserToWorkspace

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

WorkspaceId

string

工作空间 ID。

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

UserId

string

被添加的 Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****

RoleId

integer

空间角色 ID。预置角色:

  • 25:空间管理员

  • 26:空间开发者

  • 27:空间分析师

  • 30:空间查看者

说明

since 6.0.3 支持自定义角色 ID

25

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885

Result

boolean

返回接口执行结果。取值范围:

  • true:执行成功

  • false:执行失败

true

Success

boolean

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

  • true:请求成功

  • false:请求失败

true

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": true,
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
400 User.RoleType.Valid The role ID is invalid. 无效的角色ID。
400 Workspace.Not.Exist The group workspace does not exist. 群空间不存在。
400 Workspace.Type.Error The type of group workspace is invalid. 无效的群空间类型。
400 Viewer.AddInTo.Workspace Organization members with viewer type are not allowed to add to workspace: %s. 不允许将组织的访客类型用户添加到工作空间:%s。
400 User.AlreadyIn.Workspace This user already exists. 该用户已在群空间中。
400 User.AlreadyIn.Role The user is already assigned this role. 用户已经拥有该角色。
400 AnalystUser.NotSupport.AdminOrDevRole Analyst users do not support granting workspace administrator or developer roles. 分析师用户不支持授予工作空间管理员或开发者员角色。
400 UserAnalyst.NotSupport.ThisRole This role has permissions that analysts cannot grant. 该角色具有分析员无法授予的权限。
400 Viewer.CannotHave.CustomRole Organization viewer cannot have custom roles. 组织访问者不能具有自定义角色。
400 BindRole.NotExist.Error Bind role not exist, %s. 绑定的角色不存在,%s。

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

变更历史

更多信息,参考变更详情