Use ListWorkspaceRoleUsers to get users of a specific workspace role - Quick BI - Alibaba Cloud - Quick BI

Retrieves the list of users assigned to a specified workspace role.

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:ListWorkspaceRoleUsers

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RoleId	integer	Yes	The workspace role ID. Predefined and custom roles are supported: 25: Workspace Administrator (predefined role) 26: Developer (predefined role) 27: Analyst (predefined role) 30: Viewer (predefined role) Custom roles: The role ID of the custom role	25
WorkspaceId	string	No	The workspace ID. If you do not specify this parameter, the roles of all workspaces are returned.	726bee5a-****-43e1-9a8e-b550f0120f35
PageNum	integer	No	The page number. Valid values: Starting value: 1 Default value: 1	1
PageSize	integer	No	The number of entries per page. Valid values: Default value: 10 Maximum value: 1000	10
Keyword	string	No	The keyword used to filter users by nickname.	测试pop用户

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The list of users assigned to the specified workspace role.
Data	array<object>	The list of users.
	object	The user details.
NickName	string	The nickname of the organization member.	测试用户
UserId	string	The user ID of the organization member in Quick BI.	b5d8fd9348cc4327****afb604
WorkspaceId	string	The workspace ID.	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	The workspace name.	测试空间
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalNum	integer	The total number of entries.	1
TotalPages	integer	The total number of pages.	1
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "NickName": "测试用户",
        "UserId": "b5d8fd9348cc4327****afb604\n",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Workspace	The workspace is not owned by the organization.
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.