REST API for Oracle Private Cloud Appliance Compute Enclave

200 Response

The policy was retrieved.

Headers

etag: string

For optimistic concurrency control. See if-match.
opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Policy

Type: object

A document that specifies the type of access a group has to the resources in a compartment. For information about policies, see "Managing Policies" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-manage-policies.html). The word "policy" is used by people in different ways:

An individual statement written in the policy language.

A collection of statements in a single, named policy document (which has an OCID assigned to it).

The overall body of policies your organization uses to control access to resources.

Avoid entering confidential information when you supply string values using the API.

Show Source

compartmentId(required): string

The OCID of the compartment containing the policy (either the tenancy or another compartment).
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
description(required): string

Minimum Length: 1

Maximum Length: 400

The description you assign to the policy. Does not need to be unique, and it is changeable.
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
id(required): string

The OCID of the policy.
inactiveStatus: integer(int64)

The detailed status of INACTIVE lifecycleState.
lifecycleState(required): string

Minimum Length: 1

Maximum Length: 64

Allowed Values: [ "CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED" ]

The policy's current state. After creating a policy, make sure its lifecycleState changes from CREATING to ACTIVE before using it.
name(required): string

Minimum Length: 1

Maximum Length: 100

The name you assign to the policy during creation. The name must be unique across all policies in the tenancy and cannot be changed.
statements(required): array statements

An array of one or more policy statements written in the policy language.
timeCreated(required): string(date-time)

Date and time the policy was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
versionDate: string(date-time)

The version of the policy. If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.

{
    "description":"A document that specifies the type of access a group has to the resources in a compartment. For information about policies, see \"Managing Policies\" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-manage-policies.html). The word \"policy\" is used by people in different ways:<li>An individual statement written in the policy language.<li>A collection of statements in a single, named policy document (which has an OCID assigned to it).<li>The overall body of policies your organization uses to control access to resources.<p>Avoid entering confidential information when you supply string values using the API.",
    "required":[
        "id",
        "compartmentId",
        "name",
        "statements",
        "description",
        "timeCreated",
        "lifecycleState"
    ],
    "x-obmcs-splat":{
        "resourceKind":"policy",
        "adLocality":"regional"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the policy."
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment containing the policy (either the tenancy or another compartment)."
        },
        "name":{
            "type":"string",
            "description":"The name you assign to the policy during creation. The name must be unique across all policies in the tenancy and cannot be changed.",
            "minLength":"1",
            "maxLength":"100"
        },
        "statements":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"An array of one or more policy statements written in the policy language."
        },
        "description":{
            "type":"string",
            "description":"The description you assign to the policy. Does not need to be unique, and it is changeable.",
            "minLength":"1",
            "maxLength":"400"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time the policy was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z "
        },
        "lifecycleState":{
            "type":"string",
            "enum":[
                "CREATING",
                "ACTIVE",
                "INACTIVE",
                "DELETING",
                "DELETED"
            ],
            "description":"The policy's current state. After creating a policy, make sure its lifecycleState changes from CREATING to ACTIVE before using it.",
            "minLength":"1",
            "maxLength":"64"
        },
        "inactiveStatus":{
            "type":"integer",
            "format":"int64",
            "description":"The detailed status of INACTIVE lifecycleState."
        },
        "versionDate":{
            "type":"string",
            "format":"date-time",
            "description":"The version of the policy. If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date."
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : statements

Type: array

An array of one or more policy statements written in the policy language.

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"An array of one or more policy statements written in the policy language."
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported."
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

403 Response

Forbidden

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}