Deletes specified users from a row-level permission rule.
Operation description
This API supports only the new row-level permission model of Quick BI. If you use the old row-level permissions, you must migrate to the new model before you call this API. To migrate, go to Organization Management > Security Settings > Upgrade to New Row-level Permissions and click One-click Upgrade.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
quickbi-public:DeleteDataLevelPermissionRuleUsers |
delete |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DeleteUserModel |
string |
Yes |
{ "ruleId": "a5bb24da--a891683e14da", // The ID of the row-level permission rule. "cubeId": "7c7223ae--3c744528014b", // The ID of the dataset. "delModel": { "userGroups": [ "0d5fb19b--1248fc27ca51", // The ID of the user group to remove. "3d2c23d4--f6390f325c2d" ], "users": [ "4334358", // The ID of the user to remove. "Huang3fa822" ] } } |
{"ruleId":"a5bb24da-***-a891683e14da","cubeId":"7c7223ae-***-3c744528014b","delModel":{"userGroups":["0d5fb19b-***-1248fc27ca51","3d2c23d4-***-f6390f325c2d"],"users":["4334***358","Huang***3fa822"]}} |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
D8749D65-E80A-433C-AF1B-CE9C180FF3B4 |
| Result |
boolean |
The result of the API call. Valid values:
|
true |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
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. | |
| 400 | CubePermission.Columnlevel.VersionError | You are not allowed to use the new dataLevelPermission API. | |
| 400 | RowLevelPermission.SwitchClose.Error | The row level permission switch must be on. | |
| 400 | RowLevelPermission.Rule.NotExsist | 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. | |
| 400 | Cube.NotBelongTo.CurrentOrganization | The cube does not belong to the current organization %s. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.