Jump to

• Request
• Response

Get list of role permissions

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}/permissions

Returns a list of permissions for a given role.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• roleKey(required): string
  Minimum Length: 1

  Maximum Length: 255

  The unique key of the Role.

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• permissionScope: string
  The scope of role permissions to be returned. Defaults to ALL

  Allowed Values: [ "DIRECT", "INHERITED", "ALL" ]
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. A list of all permissions for a given role is retrieved.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : RolePermissionCollection

Type: object

A collection of permission summaries associated with a role.

Show Source

• items(required): array items
  Maximum Number of Items: 100

  Role permissions.

{
    "type":"object",
    "description":"A collection of permission summaries associated with a role.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"Role permissions.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/RolePermissionSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Maximum Number of Items: 100

Role permissions.

Show Source

• Array of: object RolePermissionSummary
  Summary of role permissions.

{
    "description":"Role permissions.",
    "type":"array",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/RolePermissionSummary"
    }
}

Nested Schema : RolePermissionSummary

Type: object

Summary of role permissions.

Show Source

• permissionsWithResourceDetails(required): object ListPermissionsWithResourceDetails
  List of permissions/privileges with resource details.
• roleDescription: string
  Maximum Length: 1024

  The description of the role.
• roleKey(required): string
  Maximum Length: 64

  Role attached to this permission entry.

{
    "type":"object",
    "description":"Summary of role permissions.",
    "required":[
        "roleKey",
        "permissionsWithResourceDetails"
    ],
    "properties":{
        "permissionsWithResourceDetails":{
            "$ref":"#/definitions/ListPermissionsWithResourceDetails"
        },
        "roleKey":{
            "description":"Role attached to this permission entry.",
            "type":"string",
            "maxLength":64
        },
        "roleDescription":{
            "description":"The description of the role.",
            "type":"string",
            "maxLength":1024
        }
    }
}

Nested Schema : ListPermissionsWithResourceDetails

Type: object

List of permissions/privileges with resource details.

Show Source

• permissions(required): array permissions
  Maximum Number of Items: 100

  List of privilege names.
• resourceKey(required): string
  Workspace and its sub-resources key. For example - For workspaceKey, clusterKey its a UUID Within catalog its a 3 level namespace tableKey - .. schemaKey - . catalogKey -
• resourceType(required): string
  Allowed Values: [ "WORKSPACE", "WORKFLOW", "FOLDER", "FILE", "CLUSTER", "MASTER_CATALOG", "CATALOG", "SCHEMA", "TABLE", "SHARE", "RECIPIENT", "VOLUME", "VIEW", "KNOWLEDGE_BASE" ]

  All sub-resources in catalog and workspace.

{
    "type":"object",
    "description":"List of permissions/privileges with resource details.",
    "required":[
        "permissions",
        "resourceType",
        "resourceKey"
    ],
    "properties":{
        "permissions":{
            "type":"array",
            "description":"List of privilege names.",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/AllPrivilegeType"
            }
        },
        "resourceType":{
            "type":"string",
            "description":"All sub-resources in catalog and workspace.",
            "x-obmcs-top-level-enum":"#/definitions/AllResourceType",
            "enum":[
                "WORKSPACE",
                "WORKFLOW",
                "FOLDER",
                "FILE",
                "CLUSTER",
                "MASTER_CATALOG",
                "CATALOG",
                "SCHEMA",
                "TABLE",
                "SHARE",
                "RECIPIENT",
                "VOLUME",
                "VIEW",
                "KNOWLEDGE_BASE"
            ]
        },
        "resourceKey":{
            "type":"string",
            "description":"Workspace and its sub-resources key.\nFor example - For workspaceKey, clusterKey its a UUID\nWithin catalog its a 3 level namespace\n   tableKey - <catalogName>.<schemaName>.<tableName> \n   schemaKey - <catalogName>.<schemaName>\n   catalogKey - <catalogName>\n"
        }
    }
}

Nested Schema : permissions

Type: array

Maximum Number of Items: 100

List of privilege names.

Show Source

• Array of: string
  Allowed Values: [ "USER", "ADMINISTRATOR", "READ", "USE", "MANAGE", "ADMIN", "CREATE_CATALOG", "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "CREATE_SCHEMA", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "CREATE_KNOWLEDGE_BASE" ]

  List of all privileges in the AI Data Platform Workbench.

{
    "type":"array",
    "description":"List of privilege names.",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/AllPrivilegeType"
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top