All Products
Search
Document Center

Quick BI:AddUserGroupMember

Last Updated:Nov 04, 2025

Adds an organization member to a specified user group.

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:AddUserGroupMembercreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserGroupIdstringYes

The ID of the user group.

555c4cd****
UserIdListstringYes

The ID of the Quick BI user. Separate multiple IDs with commas (,). Example: abc,efg. You can enter a maximum of 1000 entries.

46e537a5****,3dadsu****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3
Resultboolean

The result of adding members to a user group is returned. Valid values:

  • true: The task is added.
  • false: The tag failed to be added.
true
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3",
  "Result": true,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.ParameterAn error occurred while verifying parameters.An error occurred while verifying parameters.
400Invalid.UserThe 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.
400User.Not.In.OrganizationThe specified user is not in the organizational unit.The specified user is not in the organizational unit.
400Usergroup.Not.ExistThe user group does not exist.The user group does not exist.
400Instance.ExpiredYour instance has expired.Your instance has expired.
400Instance.Not.ExistThe specified instance does not exist.The specified instance does not exist.
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Internal.System.ErrorAn internal system error occurred.An internal system error occurred.
400Parameter.Length.ExceedParameter length exceeds maximum limit: [%s].-

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