ListPortalMenuAuthorization - Quick BI - Alibaba Cloud Documentation Center

Retrieves a list of authorization details for the menus in a BI portal.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DataPortalId	string	Yes	The ID of the BI portal.	0d173abb53e84c8ca7495429163b****

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	array<object>	A list of authorization details for the BI portal menus.
	array<object>	A list of authorization details for the portal menus.
MenuId	string	The ID of the leaf-node menu in the BI portal.	54kqgoa****
Receivers	array<object>	The details of the authorization objects for the menu.
	object	The details of the authorization objects for the menu.
ReceiverId	string	The ID of the authorization object. Note If the authorization object is an organization, this ID is the organization ID. If the authorization object is a workspace, this ID is the workspace ID.	121344444790****
ReceiverType	integer	The type of the authorization object. Valid values: 0: User 1: User group 2: Organization 3: Workspace	0
AuthPointsValue	integer	The authorization type for the menu. Valid values: 1: View 11: Edit 3: Export and view 10: Manage data entry	1
ShowOnlyWithAccess	boolean	Indicates whether the menu is visible only to authorized users. Valid values: true: The menu is visible only to authorized users. false: The menu is visible to all users.	true

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": [
    {
      "MenuId": "54kqgoa****",
      "Receivers": [
        {
          "ReceiverId": "121344444790****",
          "ReceiverType": 0,
          "AuthPointsValue": 1
        }
      ],
      "ShowOnlyWithAccess": true
    }
  ]
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.