Jump to

• Request
• Response

Update permissions for a catalog

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}/actions/managePermission

Update permission details for a catalog in an AI Data Platform Workbench.

Request

Path Parameters

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

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• 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

Body ()

The information to be updated.

Root Schema : ManageCatalogPermissionDetails

Type: object

Information to update permissions on a catalog.

Show Source

• assignCatalogPermissionDetails: object AssignCatalogPermissionDetails
  The details of the permissions assigned on the catalog to assignee.
• revokeCatalogPermissionDetails: object RevokeCatalogPermissionDetails
  The details of the permissions revoked from assignees for a catalog.

{
    "description":"Information to update permissions on a catalog.",
    "type":"object",
    "properties":{
        "assignCatalogPermissionDetails":{
            "$ref":"#/definitions/AssignCatalogPermissionDetails"
        },
        "revokeCatalogPermissionDetails":{
            "$ref":"#/definitions/RevokeCatalogPermissionDetails"
        }
    }
}

Nested Schema : AssignCatalogPermissionDetails

Type: object

The details of the permissions assigned on the catalog to assignee.

Show Source

• assignees(required): object PermissionAssignees
  The information about the assignees
• permissions(required): array permissions
  Maximum Number of Items: 100

  The permissions assigned to the assignees

{
    "description":"The details of the permissions assigned on the catalog to assignee.",
    "type":"object",
    "required":[
        "assignees",
        "permissions"
    ],
    "properties":{
        "assignees":{
            "$ref":"#/definitions/PermissionAssignees"
        },
        "permissions":{
            "type":"array",
            "description":"The permissions assigned to the assignees",
            "maxItems":100,
            "items":{
                "type":"string",
                "x-obmcs-top-level-enum":"#/definitions/CatalogPrivilege",
                "enum":[
                    "SELECT",
                    "MANAGE",
                    "CREATE_SCHEMA",
                    "ADMIN"
                ]
            }
        }
    }
}

Nested Schema : RevokeCatalogPermissionDetails

Type: object

The details of the permissions revoked from assignees for a catalog.

Show Source

• assignees(required): object PermissionAssignees
  The information about the assignees
• permissions(required): array permissions
  Maximum Number of Items: 100

  The permissions revoked from the assignees.

{
    "description":"The details of the permissions revoked from assignees for a catalog.",
    "type":"object",
    "required":[
        "assignees",
        "permissions"
    ],
    "properties":{
        "assignees":{
            "$ref":"#/definitions/PermissionAssignees"
        },
        "permissions":{
            "type":"array",
            "description":"The permissions revoked from the assignees.",
            "maxItems":100,
            "items":{
                "type":"string",
                "x-obmcs-top-level-enum":"#/definitions/CatalogPrivilege",
                "enum":[
                    "SELECT",
                    "MANAGE",
                    "CREATE_SCHEMA",
                    "ADMIN"
                ]
            }
        }
    }
}

Nested Schema : PermissionAssignees

Type: object

The information about the assignees

Show Source

• targets(required): array targets
  The names/ocids of the users, groups or roles.
• type(required): string
  Allowed Values: [ "USER", "ROLE", "GROUP" ]

  Grantee type.

{
    "type":"object",
    "description":"The information about the assignees",
    "required":[
        "type",
        "targets"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Grantee type.",
            "x-obmcs-top-level-enum":"#/definitions/GranteeType",
            "enum":[
                "USER",
                "ROLE",
                "GROUP"
            ]
        },
        "targets":{
            "type":"array",
            "description":"The names/ocids of the users, groups or roles.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : permissions

Type: array

Maximum Number of Items: 100

The permissions assigned to the assignees

Show Source

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

{
    "type":"array",
    "description":"The permissions assigned to the assignees",
    "maxItems":100,
    "items":{
        "type":"string",
        "x-obmcs-top-level-enum":"#/definitions/CatalogPrivilege",
        "enum":[
            "SELECT",
            "MANAGE",
            "CREATE_SCHEMA",
            "ADMIN"
        ]
    }
}

Nested Schema : targets

Type: array

The names/ocids of the users, groups or roles.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The names/ocids of the users, groups or roles.",
    "items":{
        "type":"string"
    }
}

Nested Schema : permissions

Type: array

Maximum Number of Items: 100

The permissions revoked from the assignees.

Show Source

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

{
    "type":"array",
    "description":"The permissions revoked from the assignees.",
    "maxItems":100,
    "items":{
        "type":"string",
        "x-obmcs-top-level-enum":"#/definitions/CatalogPrivilege",
        "enum":[
            "SELECT",
            "MANAGE",
            "CREATE_SCHEMA",
            "ADMIN"
        ]
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Permissions in the AI Data Platform Workbench catalog are updated.

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.

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"
        }
    }
}

405 Response

Method Not Allowed. Request is recognized but not supported.

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"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

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