Retrieves the permissions for a resource or principal.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dlf:ListPermissions |
get |
*All Resource
|
None | None |
Request syntax
GET /dlf/v1/auth/permissions/{catalogId}/list HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| catalogId |
string |
No |
The ID of the catalog. |
clg-paimon-xxxx |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| resourceType |
string |
Yes |
The resource type. |
CATALOG |
| database |
string |
No |
The name of the database. |
database_name |
| table |
string |
No |
The name of the table. |
table_name |
| function |
string |
No |
The name of the function. |
function_name |
| view |
string |
No |
The name of the view. |
view_name |
| principal |
string |
No |
The resource descriptor of the user. |
acs:ram::[accountId]:user/user_name |
| pageToken |
string |
No |
The token to retrieve the next page of results. If the response does not include this token, pass an empty string (""). |
"" |
| maxResults |
integer |
No |
The number of entries per page. |
1000 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| permissions |
array |
The permissions. |
|
| Permission |
The permission details. |
||
| nextPageToken |
string |
The token to retrieve the next page of results. If this parameter is null, all results have been returned. |
E8ABEB1C3DB893D16576269017992F57 |
Examples
Success response
JSON format
{
"permissions": [
{
"resourceType": "CATALOG",
"database": "database_name",
"table": "table_name",
"access": "DROP",
"principal": "acs:ram::[accountId]:user/user_name",
"columns": {
"columnNames": [
""
],
"excludedColumnNames": [
""
]
},
"function": "",
"view": "",
"expireTime": ""
}
],
"nextPageToken": "E8ABEB1C3DB893D16576269017992F57"
}
Error codes
See for a complete list.
Release notes
See Release Notes for a complete list.