ListWorkspaceRoles - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get the list of workspace roles.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:ListWorkspaceRoles	list	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	array<object>	List of workspace roles.
Data	object
AuthConfigList	array<object>	List of role authorization configurations.
authConfigList	object	Specific authorization configuration.
ActionAuthKeys	array	Authorization scope.
actionAuthKeys	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 it is a predefined role. Value range: true: Yes false: No	true
RoleId	long	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 corresponding role ID for a custom role	25
RoleName	string	Role name.	Space administrator
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": [
    {
      "AuthConfigList": [
        {
          "ActionAuthKeys": [
            "edit"
          ],
          "AuthKey": "portal_create"
        }
      ],
      "IsSystemRole": true,
      "RoleId": 25,
      "RoleName": "Space administrator"
    }
  ],
  "Success": true
}

Error codes

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

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