Set a whitelist for row-level permissions with SetDataLevelPermissionWhiteList - Quick BI - Alibaba Cloud - Quick BI

Operation description

Note

This operation supports only the new row-column permission model in Quick BI. If you are still using the old row-column permission model, migrate to the new model before you call this operation. To migrate, choose Organizations > Security Configurations > Upgrade Row-Level Permissions, and then click Upgrade.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WhiteListModel	string	Yes	{ "ruleType": "ROW_LEVEL", // The row-level permission type. "usersModel": { "userGroups": [ "0d5fb19b- -1248 fc27ca51", // The ID of the user group. "3d2c23d4--f6390f325c2d" ], "users": [ "4334 358", // Quick BI the UserID of the user. "Huang3fa822" ] }, "cubeId": "7c7223ae-31d1-4d2f-b11f-3c744528014b" }	{"ruleType":"ROW_LEVEL","usersModel":{"userGroups":["26edcb76-**-bdbab78267cb","187e6dd5-1611-4cf7-a034-1a93bd5fecf9"],"users":["4334358","Huang3fa822"]},"cubeId":"7c7223ae-**44528014b"}

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	boolean	The execution result of the operation. Valid values: true: The request was successful. false: The request failed.	true
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": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": true,
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Cube.Not.Exist	The Cube does not exist.	The Cube does not exist.
400	CubePermission.Columnlevel.VersionError	You are not allowed to use the new dataLevelPermission API.	You are not allowed to use new dataLevelPermission api.
400	RowLevelPermission.SwitchClose.Error	The row level permission switch must be on.	Row lever permission switch must be open.
400	RowLevelPermission.Rule.NotExsist	The row level permission rule does not exist: %s.	The row level permission rule does not exist: %s.
400	RowLevelPermission.Rule.NotBelongToCube	The row level permission rule does not belong to the current cube.	The row level permission rule does not belong to the current cube.
400	Cube.NotBelongTo.CurrentOrganization	The cube does not belong to the current organization %s.	Cube do not belong to current organization:%s.
400	Usergroup.NotBelongTo.CurrentOrganization	The usergroup %s does not belong to the current organization.	Usergroup %s is not belong to current organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.