Get the user list of a specified organization role using ListOrganizationRoleUsers - 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:ListOrganizationRoleUsers

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RoleId	integer	Yes	Organization role ID, including predefined roles and custom roles: Organization Administrator (predefined role): 111111111 Permission Administrator (predefined role): 111111112 Regular User (predefined role): 111111113 Custom Role: The corresponding role ID for a custom role	111111111
PageNum	integer	No	Page number. Default value is 1.	1
PageSize	integer	No	Number of items per page. Default value is 10.	10
Keyword	string	No	Keyword to filter organization members by nickname.	小刘

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	BCE45E6D-9304-4F94-86BB-5A772B1615FF
Result	object	List of users assigned to the organization role.
Data	array<object>	User list.
	object	User details.
NickName	string	Nickname of the organization member.	测试用户
UserId	string	UserID of the organization member in Quick BI.	b5d8fd9348cc4327****afb604
PageNum	integer	Page number.	10
PageSize	integer	Number of items per page as set in the request.	1
TotalNum	integer	Total number of items.	10
TotalPages	integer	Total number of pages.	1
Success	boolean	Whether the request was successful. Valid values: true: Request succeeded false: Request failed	true

Examples

Success response

JSON format

{
  "RequestId": "BCE45E6D-9304-4F94-86BB-5A772B1615FF",
  "Result": {
    "Data": [
      {
        "NickName": "测试用户",
        "UserId": "b5d8fd9348cc4327****afb604"
      }
    ],
    "PageNum": 10,
    "PageSize": 1,
    "TotalNum": 10,
    "TotalPages": 1
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	User.Role.NotExist	User role not exist: %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.