Use QueryOrganizationRoleConfig to get organization role configuration - Quick BI - Alibaba Cloud - Quick BI

Queries the configuration of a specified organization 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:QueryOrganizationRoleConfig

get

*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 role ID of the custom role	111111111

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	BCE45E6D-9304-4F94-86BB-5A772B1615FF
Result	object	Details of the organization role configuration.
AuthConfigList	array<object>	List of role permission configurations.
	object	Specific permission configurations.
AuthKey	string	Permission type: quick_monitor: Metric Monitoring subscription: Subscription Management offline_download: Self-service Data Retrieval resource_package: Resource Package Management organization_ask: Organization Access Key/Secret (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	quick_monitor
IsSystemRole	boolean	Indicates whether the role is predefined. Valid values: true: Yes false: No	true
RoleId	integer	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 role ID of the custom role	111111111
RoleName	string	Role name.	组织管理员
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful false: The request failed	true

Examples

Success response

JSON format

{
  "RequestId": "BCE45E6D-9304-4F94-86BB-5A772B1615FF",
  "Result": {
    "AuthConfigList": [
      {
        "AuthKey": "quick_monitor"
      }
    ],
    "IsSystemRole": true,
    "RoleId": 111111111,
    "RoleName": "组织管理员"
  },
  "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.