Jump to

• Request
• Response

(Preview) Manage registered model permission

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/{registeredModelKey}/actions/managePermission

(Preview) Grants or revokes READ, MANAGE, or ADMIN on a registered model's dedicated volume. The model-to-volume link is resolved on the server; no volume name is accepted from the client.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

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

  Maximum Length: 255

  The fully-qualified registered model name in the format ...

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  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.

Body ()

The grant or revoke details for the registered model.

Root Schema : ManageRegisteredModelPermissionDetails

Type: object

Information to grant or revoke permissions on a registered model's dedicated volume.

Show Source

• assignRegisteredModelPermissionDetails: object AssignRegisteredModelPermissionDetails
  The permissions assigned on the registered model to assignees.
• revokeRegisteredModelPermissionDetails: object RevokeRegisteredModelPermissionDetails
  The permissions revoked from assignees for a registered model.

{
    "description":"Information to grant or revoke permissions on a registered model's dedicated volume.",
    "type":"object",
    "properties":{
        "assignRegisteredModelPermissionDetails":{
            "$ref":"#/definitions/AssignRegisteredModelPermissionDetails"
        },
        "revokeRegisteredModelPermissionDetails":{
            "$ref":"#/definitions/RevokeRegisteredModelPermissionDetails"
        }
    }
}

Nested Schema : AssignRegisteredModelPermissionDetails

Type: object

The permissions assigned on the registered model to assignees.

Show Source

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

  Maximum Number of Items: 100

  The permissions assigned to the assignees.

{
    "description":"The permissions assigned on the registered model to assignees.",
    "type":"object",
    "required":[
        "assignees",
        "permissions"
    ],
    "properties":{
        "assignees":{
            "$ref":"#/definitions/PermissionAssignees"
        },
        "permissions":{
            "type":"array",
            "description":"The permissions assigned to the assignees.",
            "minItems":1,
            "maxItems":100,
            "items":{
                "type":"string",
                "x-obmcs-top-level-enum":"#/definitions/RegisteredModelPrivilege",
                "enum":[
                    "READ",
                    "MANAGE",
                    "ADMIN"
                ]
            }
        }
    }
}

Nested Schema : RevokeRegisteredModelPermissionDetails

Type: object

The permissions revoked from assignees for a registered model.

Show Source

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

  Maximum Number of Items: 100

  The permissions revoked from the assignees.

{
    "description":"The permissions revoked from assignees for a registered model.",
    "type":"object",
    "required":[
        "assignees",
        "permissions"
    ],
    "properties":{
        "assignees":{
            "$ref":"#/definitions/PermissionAssignees"
        },
        "permissions":{
            "type":"array",
            "description":"The permissions revoked from the assignees.",
            "minItems":1,
            "maxItems":100,
            "items":{
                "type":"string",
                "x-obmcs-top-level-enum":"#/definitions/RegisteredModelPrivilege",
                "enum":[
                    "READ",
                    "MANAGE",
                    "ADMIN"
                ]
            }
        }
    }
}

Nested Schema : PermissionAssignees

Type: object

The information about the assignees

Show Source

• targets(required): array targets
  Minimum Number of Items: 1

  Maximum Number of Items: 100

  Unique Items Required: true

  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.",
            "minItems":1,
            "maxItems":100,
            "uniqueItems":true,
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":255
            }
        }
    }
}

Nested Schema : permissions

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 100

The permissions assigned to the assignees.

Show Source

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

{
    "type":"array",
    "description":"The permissions assigned to the assignees.",
    "minItems":1,
    "maxItems":100,
    "items":{
        "type":"string",
        "x-obmcs-top-level-enum":"#/definitions/RegisteredModelPrivilege",
        "enum":[
            "READ",
            "MANAGE",
            "ADMIN"
        ]
    }
}

Nested Schema : targets

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 100

Unique Items Required: true

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

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "type":"array",
    "description":"The names/ocids of the users, groups or roles.",
    "minItems":1,
    "maxItems":100,
    "uniqueItems":true,
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":255
    }
}

Nested Schema : permissions

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 100

The permissions revoked from the assignees.

Show Source

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Registered model permissions 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"
        }
    }
}

403 Response

Forbidden or response too large to handle.

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

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