Certificate

class oci.apigateway.models.Certificate(**kwargs)

Bases: object

A certificate contains information to be installed on a gateway to secure the traffic going through it. For more information, see API Gateway Concepts.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Certificate.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Certificate.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Certificate.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Certificate.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Certificate.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Certificate.

certificate

[Required] Gets the certificate of this Certificate.

compartment_id

[Required] Gets the compartment_id of this Certificate.

defined_tags

Gets the defined_tags of this Certificate.

display_name

[Required] Gets the display_name of this Certificate.

freeform_tags

Gets the freeform_tags of this Certificate.

id

[Required] Gets the id of this Certificate.

intermediate_certificates

Gets the intermediate_certificates of this Certificate.

lifecycle_details

Gets the lifecycle_details of this Certificate.

lifecycle_state

Gets the lifecycle_state of this Certificate.

locks

Gets the locks of this Certificate.

subject_names

[Required] Gets the subject_names of this Certificate.

system_tags

Gets the system_tags of this Certificate.

time_created

[Required] Gets the time_created of this Certificate.

time_not_valid_after

[Required] Gets the time_not_valid_after of this Certificate.

time_updated

Gets the time_updated of this Certificate.

Methods:

__init__(**kwargs)

Initializes a new Certificate object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Certificate. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Certificate. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Certificate. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Certificate. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Certificate. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Certificate. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Certificate object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this Certificate.

  • display_name (str) – The value to assign to the display_name property of this Certificate.

  • compartment_id (str) – The value to assign to the compartment_id property of this Certificate.

  • subject_names (list[str]) – The value to assign to the subject_names property of this Certificate.

  • time_not_valid_after (datetime) – The value to assign to the time_not_valid_after property of this Certificate.

  • certificate (str) – The value to assign to the certificate property of this Certificate.

  • intermediate_certificates (str) – The value to assign to the intermediate_certificates property of this Certificate.

  • time_created (datetime) – The value to assign to the time_created property of this Certificate.

  • time_updated (datetime) – The value to assign to the time_updated property of this Certificate.

  • locks (list[oci.apigateway.models.ResourceLock]) – The value to assign to the locks property of this Certificate.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Certificate. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Certificate.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Certificate.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Certificate.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Certificate.

property certificate

[Required] Gets the certificate of this Certificate. The data of the leaf certificate in pem format.

Returns

The certificate of this Certificate.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this Certificate. The OCID of the compartment in which the resource is created.

Returns

The compartment_id of this Certificate.

Return type

str

property defined_tags

Gets the defined_tags of this Certificate. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this Certificate.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this Certificate. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: My new resource

Returns

The display_name of this Certificate.

Return type

str

property freeform_tags

Gets the freeform_tags of this Certificate. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this Certificate.

Return type

dict(str, str)

property id

[Required] Gets the id of this Certificate. The OCID of the resource.

Returns

The id of this Certificate.

Return type

str

property intermediate_certificates

Gets the intermediate_certificates of this Certificate. The intermediate certificate data associated with the certificate in pem format.

Returns

The intermediate_certificates of this Certificate.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Certificate. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

Returns

The lifecycle_details of this Certificate.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this Certificate. The current state of the certificate.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Certificate.

Return type

str

property locks

Gets the locks of this Certificate. Locks associated with this resource.

Returns

The locks of this Certificate.

Return type

list[oci.apigateway.models.ResourceLock]

property subject_names

[Required] Gets the subject_names of this Certificate. The entity to be secured by the certificate and additional host names.

Returns

The subject_names of this Certificate.

Return type

list[str]

property system_tags

Gets the system_tags of this Certificate. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this Certificate.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this Certificate. The time this resource was created. An RFC3339 formatted datetime string.

Returns

The time_created of this Certificate.

Return type

datetime

property time_not_valid_after

[Required] Gets the time_not_valid_after of this Certificate. The date and time the certificate will expire.

Returns

The time_not_valid_after of this Certificate.

Return type

datetime

property time_updated

Gets the time_updated of this Certificate. The time this resource was last updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this Certificate.

Return type

datetime