AddUserToWorkspace - 添加成员到工作空间

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

调试

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

授权信息

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

请求参数

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

工作空间 ID。

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

被添加的 Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****
RoleIdlong

预置空间角色 ID。取值范围:

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultboolean

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

  • true:执行成功
  • false:执行失败
true
Successboolean

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

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400User.RoleType.ValidThe role ID is invalid.无效的角色ID。
400Workspace.Not.ExistThe group workspace does not exist.群空间不存在。
400Workspace.Type.ErrorThe type of group workspace is invalid.无效的群空间类型。
400Viewer.AddInTo.WorkspaceOrganization members with viewer type are not allowed to add to workspace: %s.不允许将组织的访客类型用户添加到工作空间:%s。
400User.AlreadyIn.WorkspaceThis user already exists.该用户已在群空间中。
400User.AlreadyIn.RoleThe user is already assigned this role.用户已经拥有该角色。
400AnalystUser.NotSupport.AdminOrDevRoleAnalyst users do not support granting workspace administrator or developer roles.分析师用户不支持授予工作空间管理员或开发者员角色。
400UserAnalyst.NotSupport.ThisRoleThis role has permissions that analysts cannot grant.该角色具有分析员无法授予的权限。
400Viewer.CannotHave.CustomRoleOrganization viewer cannot have custom roles.组织访问者不能具有自定义角色。

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

变更历史

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