Jump to

• Request
• Response

Get volume permissions

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/permissions

Returns a list of volume permissions.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• volumeKey(required): string
  The key of the volume.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. A page of volume permission summary objects 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 : VolumePermissionCollection

Type: object

List of volume permissions.

Show Source

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

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

Nested Schema : items

Type: array

List of volume permissions.

Show Source

• Array of: object VolumePermissionSummary
  Information about a volume permission.

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

Nested Schema : VolumePermissionSummary

Type: object

Information about a volume permission.

Show Source

• 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 volume.
• granteeType(required): string
  Allowed Values: [ "USER", "ROLE", "GROUP" ]

  The type of grantee.
• isInherited: boolean
  The permission listed is inherited or not from object up in hierarchy.
• resourceName: string
  Name of the object to which this permission belongs to. This would be the name of a table if permission is not inherited or name of the object up in hierarchy if permission is inherited.

{
    "description":"Information about a volume 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 volume.",
            "maxItems":100,
            "items":{
                "type":"string",
                "x-obmcs-top-level-enum":"#/definitions/AllVolumePrivilege",
                "enum":[
                    "READ",
                    "WRITE",
                    "ADMIN",
                    "SELECT",
                    "MANAGE"
                ]
            }
        },
        "isInherited":{
            "type":"boolean",
            "description":"The permission listed is inherited or not from object up in hierarchy."
        },
        "resourceName":{
            "type":"string",
            "description":"Name of the object to which this permission belongs to. This would be the name of a table if permission is not inherited or name of the object up in hierarchy if permission is inherited."
        }
    }
}

Nested Schema : granteePermissions

Type: array

Maximum Number of Items: 100

The selected permissions for a volume.

Show Source

• Array of: string
  Allowed Values: [ "READ", "WRITE", "ADMIN", "SELECT", "MANAGE" ]

{
    "type":"array",
    "description":"The selected permissions for a volume.",
    "maxItems":100,
    "items":{
        "type":"string",
        "x-obmcs-top-level-enum":"#/definitions/AllVolumePrivilege",
        "enum":[
            "READ",
            "WRITE",
            "ADMIN",
            "SELECT",
            "MANAGE"
        ]
    }
}

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