Grant permissions for BI portal menus to users and user groups using AuthorizeMenu - Quick BI - Alibaba Cloud - Quick BI

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DataPortalId	string	Yes	The ID of the BI portal.	0d173abb53e84c8ca7495429163b****
MenuIds	string	Yes	The menu IDs of BI portal leaf nodes. Directory menus cannot be authorized. Separate multiple IDs with commas (,). You can specify up to 100 menu IDs at a time.	54kqgoa**,pg1n135**
UserGroupIds	string	No	The IDs of user groups. Separate multiple IDs with commas (,). You can specify up to 200 user group IDs at a time. UserGroupIds and UserIds cannot both be empty.	34fd141d-4598-4093-8c33-8e066dcb**,3d2c23d4-2b41-4af8-a1f5-f6390f32**
UserIds	string	No	The IDs of end users. Use the Quick BI user ID, not the Alibaba Cloud UID. Separate multiple IDs with commas (,). You can specify up to 200 user IDs at a time.	204627493484**,121344444790**
AuthPointsValue	integer	No	The permission level to grant for the menus. Valid values: 1: view 3: View + Export (default)	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	188F0B12-00EF-41B3-944A-FB7EF06C9F43
Result	integer	The number of authorized menus.	2
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": "188F0B12-00EF-41B3-944A-FB7EF06C9F43",
  "Result": 2,
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	Report.NotExist.Error	This work does not exist. It may have been deleted. Work ID is %s.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.
400	AccessMenu.NotMatch.Portal	The menu does not match the BI portal.
400	FolderMenu.CanNot.Authorize	The folder type menu cannot be authorized. Menu ID: %s.
400	Menu.NotBelongTo.CurrentDataportal	Menu %s does not belong to the current data portal %s.
400	User.NotBelongTo.CurrentOrganization	The user %s does not belong to the current organization.
400	Usergroup.NotBelongTo.CurrentOrganization	The usergroup %s does not belong to the current organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.