Get catalog item ACL
post
/api/20210901/catalog/{type}/{id}/actions/getACL
Get the access control list (ACL) for a catalog item with a given id.
Request
Path Parameters
-
id(required): string
Catalog item ID in base64url format.
-
type(required):
Type of catalog item. The content types that this API supports include folders, workbooks, subject areas, analyses, dashboards, dashboard pages, reports, connections, datasets, data flows, sequences, scripts, and semantic models.
Supported Media Types
- */*
Root Schema : schema
Type:
string
Allowed Values:
[
""
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : CatalogItemACL
Type:
Show Source
object
-
accountDisplayName: string
Display name for the user or application role, if available.
-
accountGuid(required): string
User ID or application role name.
-
accountType(required): string
Allowed Values:
[ "User", "ApplicationRole" ]
-
permissions: object
Permissions
400 Response
Bad Request (invalid query parameters, malformed headers, and so on).
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
401 Response
Unauthorized (missing or expired credentials, and so on).
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
403 Response
Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
404 Response
Not Found. The requested resource was not found.
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
500 Response
Internal Server Error. The server encountered an unexpected condition
preventing fulfilment of the request.
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
Examples
This example shows you how to obtain the access control list (ACL) for a specific catalog object, MySalesWorkbook
. The object type
value is workbooks
. The object ID of the workbook is /@Catalog/shared/Sales/MySalesWorkbook
which has the Base64URL-safe encoded id
value L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s
cURL Example:
First, obtain the object ID of the workbook you want ACL details for. Base64URL-safe encode the value to determine the id
. You can obtain the Object ID value from the Inspect dialog for the object in Oracle Analytics Cloud.
Run the cURL command with the required type
and id
:
curl -i \ --header 'Authorization: Bearer <token>' \ --header 'Content-Length: 0' \ --request POST 'https://<hostname>/api/20210901/catalog/workbooks/L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s=/actions/getACL'
Example of Request Body
Not applicable.
Example of Response Body
Status 200:
[ { "accountGuid": "BIConsumer", "accountType": "ApplicationRole", "accountDisplayName": "BI Consumer", "permissions": { "read": true, "write": false, "list": true, "delete": false, "changePermission": false, "takeOwnership": false } }, { "accountGuid": "BIServiceAdministrator", "accountType": "ApplicationRole", "accountDisplayName": "BI Service Administrator", "permissions": { "read": true, "write": true, "list": true, "delete": true, "changePermission": true, "takeOwnership": true } } ]