Use ListWorkspaceRoles to get a list of workspace roles - Quick BI - Alibaba Cloud - Quick BI

Retrieves the list of roles in a workspace.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	array<object>	List of workspace roles.
	array<object>
AuthConfigList	array<object>	List of role authorization configurations.
	object	Authorization configuration details.
ActionAuthKeys	array	Authorization scope.
	string	Specific permissions: edit: Create use: Use list: Display list	edit
AuthKey	string	Authorization type: portal_create: Data Portal dashboard_create: Dashboard report_create: Spreadsheet screen_create: Data Screen analysis: Ad-hoc Analysis offline_download: Self-service Data Retrieval data_form: Data Entry quick_etl: Data Preparation cube: Dataset datasource: Data Source	portal_create
IsSystemRole	boolean	Whether the role is predefined. Valid values: true: Yes false: No	true
RoleId	integer	Workspace role ID, including predefined and custom roles: 25: Workspace Administrator (predefined role) 26: Developer (predefined role) 27: Analyst (predefined role) 30: Viewer (predefined role) Custom role: The role ID of the custom role	25
RoleName	string	Role name.	空间管理员
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": [
    {
      "AuthConfigList": [
        {
          "ActionAuthKeys": [
            "edit"
          ],
          "AuthKey": "portal_create"
        }
      ],
      "IsSystemRole": true,
      "RoleId": 25,
      "RoleName": "空间管理员"
    }
  ],
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Workspace	The workspace is not owned by the organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.