Use AddUserGroupMembers to add users to a user group - Quick BI - Alibaba Cloud - Quick BI

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:AddUserGroupMembers

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The user ID in Quick BI.	46e5****37a5
UserGroupIds	string	Yes	The IDs of the user groups. Separate the IDs with commas (,). Example: aGroupId,bGroupId,cGroupIds	0d5fb19b-**-**-99da-1248fc27ca51

Response elements

Element	Type	Description	Example
	object	The response structure.
RequestId	string	The ID of the request.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	boolean	The execution result of the operation. Valid values: true: The request was successful. false: The request failed.	true
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": true,
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.User	The user does not exist and cannot be added to a user group.	The user does not exist and cannot be added to the user group.
400	Usergroup.Not.Exist	The user group does not exist.	The user group does not exist.
400	Invalid.Parameter	The length of the parameter must not exceed 1000.
400	UserGroup.Already.Synchronized	Organization has synchronized with other organizational structures, so you are not allowed to add users under group.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.