CertificateAuthoritySummary

class oci.certificates_management.models.CertificateAuthoritySummary(**kwargs)

Bases: object

The metadata details of the certificate authority (CA). This summary object does not contain the CA contents.

Attributes:

CONFIG_TYPE_ROOT_CA_GENERATED_INTERNALLY

A constant which can be used with the config_type property of a CertificateAuthoritySummary.

CONFIG_TYPE_ROOT_CA_MANAGED_EXTERNALLY

A constant which can be used with the config_type property of a CertificateAuthoritySummary.

CONFIG_TYPE_SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA

A constant which can be used with the config_type property of a CertificateAuthoritySummary.

CONFIG_TYPE_SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA

A constant which can be used with the config_type property of a CertificateAuthoritySummary.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CANCELLING_DELETION

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_PENDING_ACTIVATION

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

LIFECYCLE_STATE_PENDING_DELETION

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

LIFECYCLE_STATE_SCHEDULING_DELETION

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

LIFECYCLE_STATE_UPDATING

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

SIGNING_ALGORITHM_SHA256_WITH_ECDSA

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary.

SIGNING_ALGORITHM_SHA256_WITH_RSA

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary.

SIGNING_ALGORITHM_SHA384_WITH_ECDSA

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary.

SIGNING_ALGORITHM_SHA384_WITH_RSA

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary.

SIGNING_ALGORITHM_SHA512_WITH_ECDSA

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary.

SIGNING_ALGORITHM_SHA512_WITH_RSA

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary.

certificate_authority_rules

Gets the certificate_authority_rules of this CertificateAuthoritySummary.

compartment_id

[Required] Gets the compartment_id of this CertificateAuthoritySummary.

config_type

[Required] Gets the config_type of this CertificateAuthoritySummary.

current_version_summary

Gets the current_version_summary of this CertificateAuthoritySummary.

defined_tags

Gets the defined_tags of this CertificateAuthoritySummary.

description

Gets the description of this CertificateAuthoritySummary.

freeform_tags

Gets the freeform_tags of this CertificateAuthoritySummary.

id

[Required] Gets the id of this CertificateAuthoritySummary.

issuer_certificate_authority_id

Gets the issuer_certificate_authority_id of this CertificateAuthoritySummary.

kms_key_id

Gets the kms_key_id of this CertificateAuthoritySummary.

lifecycle_state

[Required] Gets the lifecycle_state of this CertificateAuthoritySummary.

name

[Required] Gets the name of this CertificateAuthoritySummary.

signing_algorithm

Gets the signing_algorithm of this CertificateAuthoritySummary.

subject

Gets the subject of this CertificateAuthoritySummary.

time_created

[Required] Gets the time_created of this CertificateAuthoritySummary.

time_of_deletion

Gets the time_of_deletion of this CertificateAuthoritySummary.

Methods:

__init__(**kwargs)

Initializes a new CertificateAuthoritySummary object with values from keyword arguments.

CONFIG_TYPE_ROOT_CA_GENERATED_INTERNALLY = 'ROOT_CA_GENERATED_INTERNALLY'

A constant which can be used with the config_type property of a CertificateAuthoritySummary. This constant has a value of “ROOT_CA_GENERATED_INTERNALLY”

CONFIG_TYPE_ROOT_CA_MANAGED_EXTERNALLY = 'ROOT_CA_MANAGED_EXTERNALLY'

A constant which can be used with the config_type property of a CertificateAuthoritySummary. This constant has a value of “ROOT_CA_MANAGED_EXTERNALLY”

CONFIG_TYPE_SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA = 'SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA'

A constant which can be used with the config_type property of a CertificateAuthoritySummary. This constant has a value of “SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA”

CONFIG_TYPE_SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA = 'SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA'

A constant which can be used with the config_type property of a CertificateAuthoritySummary. This constant has a value of “SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_PENDING_ACTIVATION = 'PENDING_ACTIVATION'

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

LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'

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

LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SIGNING_ALGORITHM_SHA256_WITH_ECDSA = 'SHA256_WITH_ECDSA'

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary. This constant has a value of “SHA256_WITH_ECDSA”

SIGNING_ALGORITHM_SHA256_WITH_RSA = 'SHA256_WITH_RSA'

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary. This constant has a value of “SHA256_WITH_RSA”

SIGNING_ALGORITHM_SHA384_WITH_ECDSA = 'SHA384_WITH_ECDSA'

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary. This constant has a value of “SHA384_WITH_ECDSA”

SIGNING_ALGORITHM_SHA384_WITH_RSA = 'SHA384_WITH_RSA'

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary. This constant has a value of “SHA384_WITH_RSA”

SIGNING_ALGORITHM_SHA512_WITH_ECDSA = 'SHA512_WITH_ECDSA'

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary. This constant has a value of “SHA512_WITH_ECDSA”

SIGNING_ALGORITHM_SHA512_WITH_RSA = 'SHA512_WITH_RSA'

A constant which can be used with the signing_algorithm property of a CertificateAuthoritySummary. This constant has a value of “SHA512_WITH_RSA”

__init__(**kwargs)

Initializes a new CertificateAuthoritySummary 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 CertificateAuthoritySummary.

  • issuer_certificate_authority_id (str) – The value to assign to the issuer_certificate_authority_id property of this CertificateAuthoritySummary.

  • name (str) – The value to assign to the name property of this CertificateAuthoritySummary.

  • description (str) – The value to assign to the description property of this CertificateAuthoritySummary.

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

  • time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this CertificateAuthoritySummary.

  • kms_key_id (str) – The value to assign to the kms_key_id property of this CertificateAuthoritySummary.

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

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

  • certificate_authority_rules (list[oci.certificates_management.models.CertificateAuthorityRule]) – The value to assign to the certificate_authority_rules property of this CertificateAuthoritySummary.

  • current_version_summary (oci.certificates_management.models.CertificateAuthorityVersionSummary) – The value to assign to the current_version_summary property of this CertificateAuthoritySummary.

  • subject (oci.certificates_management.models.CertificateSubject) – The value to assign to the subject property of this CertificateAuthoritySummary.

  • config_type (str) – The value to assign to the config_type property of this CertificateAuthoritySummary. Allowed values for this property are: “ROOT_CA_GENERATED_INTERNALLY”, “SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA”, “ROOT_CA_MANAGED_EXTERNALLY”, “SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • signing_algorithm (str) – The value to assign to the signing_algorithm property of this CertificateAuthoritySummary. Allowed values for this property are: “SHA256_WITH_RSA”, “SHA384_WITH_RSA”, “SHA512_WITH_RSA”, “SHA256_WITH_ECDSA”, “SHA384_WITH_ECDSA”, “SHA512_WITH_ECDSA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

property certificate_authority_rules

Gets the certificate_authority_rules of this CertificateAuthoritySummary. An optional list of rules that control how the CA is used and managed.

Returns

The certificate_authority_rules of this CertificateAuthoritySummary.

Return type

list[oci.certificates_management.models.CertificateAuthorityRule]

property compartment_id

[Required] Gets the compartment_id of this CertificateAuthoritySummary. The OCID of the compartment under which the CA is created.

Returns

The compartment_id of this CertificateAuthoritySummary.

Return type

str

property config_type

[Required] Gets the config_type of this CertificateAuthoritySummary. The origin of the CA.

Allowed values for this property are: “ROOT_CA_GENERATED_INTERNALLY”, “SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA”, “ROOT_CA_MANAGED_EXTERNALLY”, “SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The config_type of this CertificateAuthoritySummary.

Return type

str

property current_version_summary

Gets the current_version_summary of this CertificateAuthoritySummary.

Returns

The current_version_summary of this CertificateAuthoritySummary.

Return type

oci.certificates_management.models.CertificateAuthorityVersionSummary

property defined_tags

Gets the defined_tags of this CertificateAuthoritySummary. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this CertificateAuthoritySummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CertificateAuthoritySummary. A brief description of the CA.

Returns

The description of this CertificateAuthoritySummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this CertificateAuthoritySummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this CertificateAuthoritySummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this CertificateAuthoritySummary. The OCID of the certificate authority (CA).

Returns

The id of this CertificateAuthoritySummary.

Return type

str

property issuer_certificate_authority_id

Gets the issuer_certificate_authority_id of this CertificateAuthoritySummary. The OCID of the parent CA which issued this CA. If this is the root CA, then this value is the same as the id.

Returns

The issuer_certificate_authority_id of this CertificateAuthoritySummary.

Return type

str

property kms_key_id

Gets the kms_key_id of this CertificateAuthoritySummary. The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt the CA.

Returns

The kms_key_id of this CertificateAuthoritySummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this CertificateAuthoritySummary. The current lifecycle state of the CA.

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

Returns

The lifecycle_state of this CertificateAuthoritySummary.

Return type

str

property name

[Required] Gets the name of this CertificateAuthoritySummary. A user-friendly name for the CA. Names are unique within a compartment. Avoid entering confidential information. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

Returns

The name of this CertificateAuthoritySummary.

Return type

str

property signing_algorithm

Gets the signing_algorithm of this CertificateAuthoritySummary. The algorithm used to sign public key certificates that the CA issues.

Allowed values for this property are: “SHA256_WITH_RSA”, “SHA384_WITH_RSA”, “SHA512_WITH_RSA”, “SHA256_WITH_ECDSA”, “SHA384_WITH_ECDSA”, “SHA512_WITH_ECDSA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The signing_algorithm of this CertificateAuthoritySummary.

Return type

str

property subject

Gets the subject of this CertificateAuthoritySummary.

Returns

The subject of this CertificateAuthoritySummary.

Return type

oci.certificates_management.models.CertificateSubject

property time_created

[Required] Gets the time_created of this CertificateAuthoritySummary. A property indicating when the CA was created, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns

The time_created of this CertificateAuthoritySummary.

Return type

datetime

property time_of_deletion

Gets the time_of_deletion of this CertificateAuthoritySummary. An optional property indicating when to delete the CA version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns

The time_of_deletion of this CertificateAuthoritySummary.

Return type

datetime