All Products
Search
Document Center

Quick BI:ListOrganizationRoles

Last Updated:Nov 04, 2025
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.

Retrieve the list of custom roles at the organization level.

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

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Resultarray<object>

Returns the list of organization roles.

Dataobject

Details of role configuration.

AuthConfigListarray<object>

List of role permission configurations.

authConfigListobject

Specific permission configuration.

AuthKeystring

Permission type:

  • quick_monitor: Metric monitoring
  • subscription: Subscription management
  • offline_download: Self-service data retrieval
  • resource_package: Resource package management
  • organization_ask: Organization identification code (AK/SK)
  • developer_openapi: OpenAPI
  • data_service: Data service
  • admin_authorize3rd: Embedded analysis
  • component_manage: Custom component
  • template_open: Custom template
  • custom_driver: Custom driver (supported only in standalone deployment)
  • open_platform_custom_plugin: Custom plugin (supported only in standalone deployment)
  • enterprise_safety: Enterprise security
enterprise_safety
IsSystemRoleboolean

Whether it is a predefined role. Possible values:

  • true: Yes
  • false: No
true
RoleIdlong

Role ID.

111111111
RoleNamestring

Role name.

Organization Admin
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": "7AAB95D7-2E11-4FE2-94BC-858E4FC0C976",
  "Result": [
    {
      "AuthConfigList": [
        {
          "AuthKey": "enterprise_safety"
        }
      ],
      "IsSystemRole": true,
      "RoleId": 111111111,
      "RoleName": "Organization Admin"
    }
  ],
  "Success": true
}

Error codes

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