Jump to

• Request
• Response

Get table permissions

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/permissions

Returns a list of permissions for a given table.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• tableKey(required): string
  The fully qualified name of the table in the format ...

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).
• 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.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. List of table permissions 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 : TablePermissionCollection

Type: object

List of table permissions.

Show Source

• items(required): array items
  List of table permissions.

{
    "type":"object",
    "description":"List of table permissions.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of table permissions.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TablePermissionSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of table permissions.

Show Source

• Array of: object TablePermissionSummary
  Information about a table permission.

{
    "description":"List of table permissions.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TablePermissionSummary"
    }
}

Nested Schema : TablePermissionSummary

Type: object

Information about a table permission.

Show Source

• columns: array columns
  Maximum Number of Items: 100

  The list of the columns included for permission assignment.
• excludeColumns: array excludeColumns
  Maximum Number of Items: 100

  The list of the columns excluded from permission assignment.
• grantee(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of user/group and name in case of role.
• granteeName: string
  Minimum Length: 1

  Maximum Length: 255

  The simplified name of the grantee.
• granteePermissions(required): array granteePermissions
  Maximum Number of Items: 100

  The selected permissions for a table.
• granteeType(required): string
  Allowed Values: [ "USER", "ROLE", "GROUP" ]

  The type of grantee.
• isInherited: boolean
  If the permission listed is inherited or not from object higher up in hierarchy.
• resourceName: string
  Name of the object to which this permission belong to. Name of table if permission is not inherited or name of object higher up in hierarchy if permission is inherited.

{
    "description":"Information about a table permission.",
    "type":"object",
    "required":[
        "grantee",
        "granteeType",
        "granteePermissions"
    ],
    "properties":{
        "grantee":{
            "description":"The OCID of user/group and name in case of role.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "granteeName":{
            "description":"The simplified name of the grantee.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "granteeType":{
            "description":"The type of grantee.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/GranteeType",
            "enum":[
                "USER",
                "ROLE",
                "GROUP"
            ]
        },
        "granteePermissions":{
            "type":"array",
            "description":"The selected permissions for a table.",
            "maxItems":100,
            "items":{
                "type":"string",
                "x-obmcs-top-level-enum":"#/definitions/TablePrivilege",
                "enum":[
                    "SELECT",
                    "MANAGE",
                    "WRITE",
                    "INSERT",
                    "UPDATE",
                    "DELETE",
                    "ALTER",
                    "ADMIN"
                ]
            }
        },
        "columns":{
            "description":"The list of the columns included for permission assignment.",
            "type":"array",
            "maxItems":100,
            "items":{
                "type":"string"
            }
        },
        "excludeColumns":{
            "description":"The list of the columns excluded from permission assignment.",
            "type":"array",
            "maxItems":100,
            "items":{
                "type":"string"
            }
        },
        "isInherited":{
            "type":"boolean",
            "description":"If the permission listed is inherited or not from object higher up in hierarchy."
        },
        "resourceName":{
            "type":"string",
            "description":"Name of the object to which this permission belong to. Name of table if permission is not inherited or name of object higher up in hierarchy if permission is inherited."
        }
    }
}

Nested Schema : columns

Type: array

Maximum Number of Items: 100

The list of the columns included for permission assignment.

Show Source

• Array of: string

{
    "description":"The list of the columns included for permission assignment.",
    "type":"array",
    "maxItems":100,
    "items":{
        "type":"string"
    }
}

Nested Schema : excludeColumns

Type: array

Maximum Number of Items: 100

The list of the columns excluded from permission assignment.

Show Source

• Array of: string

{
    "description":"The list of the columns excluded from permission assignment.",
    "type":"array",
    "maxItems":100,
    "items":{
        "type":"string"
    }
}

Nested Schema : granteePermissions

Type: array

Maximum Number of Items: 100

The selected permissions for a table.

Show Source

• Array of: string
  Allowed Values: [ "SELECT", "MANAGE", "WRITE", "INSERT", "UPDATE", "DELETE", "ALTER", "ADMIN" ]

{
    "type":"array",
    "description":"The selected permissions for a table.",
    "maxItems":100,
    "items":{
        "type":"string",
        "x-obmcs-top-level-enum":"#/definitions/TablePrivilege",
        "enum":[
            "SELECT",
            "MANAGE",
            "WRITE",
            "INSERT",
            "UPDATE",
            "DELETE",
            "ALTER",
            "ADMIN"
        ]
    }
}

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