All Products
Search
Document Center

Quick BI:AddUserToWorkspace

Last Updated:Apr 17, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Add a member to the specified workspace.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
quickbi-public:AddUserToWorkspacecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
WorkspaceIdstringYes

The ID of the workspace.

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

The ID of the Quick BI user to be added.

de4bc5f9429141cc8091cdd1c15b****
RoleIdlongYes

The preset space role ID. Value range:

  • 25: Space Administrator
  • 26: Space Developer
  • 27: Space Analyst
  • 30: Space Viewer
25

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultboolean

Returns the result of the interface execution. Value range:

  • true: Execution successful
  • false: Execution failed
true
Successboolean

Indicates whether the request was successful. Value range:

  • true: Request successful
  • false: Request failed
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.The workspace is not owned by the organization.
400User.RoleType.ValidThe role ID is invalid.The role ID is invalid.
400Workspace.Not.ExistThe group workspace does not exist.The group workspace does not exist.
400Workspace.Type.ErrorThe type of group workspace is invalid.The type of group workspace is invalid.
400Viewer.AddInTo.WorkspaceOrganization members with viewer type are not allowed to add to workspace: %s.Organization members with viewer type are not allowed to add to workspace: %s.
400User.AlreadyIn.WorkspaceThis user already exists.This user already exists.
400User.AlreadyIn.RoleThe user is already assigned this role.The 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.This role has permissions that analysts cannot grant.
400Viewer.CannotHave.CustomRoleOrganization viewer cannot have custom roles.Organization viewer cannot have custom roles.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-07The Error code has changedView Change Details