QueryOrganizationRoleConfig - 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.

Gets the configuration of the specified organization role.

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:QueryOrganizationRoleConfig	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RoleId	long	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 corresponding role ID of the custom role	111111111

Response parameters

Parameter	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.
authConfigList	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	Whether it is a predefined role. Possible values: true: Yes false: No	true
RoleId	long	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 corresponding role ID of the custom role	111111111
RoleName	string	Role name.	Organization Admin
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": "BCE45E6D-9304-4F94-86BB-5A772B1615FF",
  "Result": {
    "AuthConfigList": [
      {
        "AuthKey": "quick_monitor"
      }
    ],
    "IsSystemRole": true,
    "RoleId": 111111111,
    "RoleName": "Organization Admin"
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	User.Role.NotExist	User role not exist: %s.

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