CertificateAuthority¶
- class oci.certificates_management.models.CertificateAuthority(**kwargs)¶
Bases:
objectThe metadata details of the certificate authority (CA). This object does not contain the CA contents.
Attributes:
A constant which can be used with the config_type property of a CertificateAuthority.
A constant which can be used with the config_type property of a CertificateAuthority.
A constant which can be used with the config_type property of a CertificateAuthority.
CONFIG_TYPE_SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CAA constant which can be used with the config_type property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the lifecycle_state property of a CertificateAuthority.
A constant which can be used with the signing_algorithm property of a CertificateAuthority.
A constant which can be used with the signing_algorithm property of a CertificateAuthority.
A constant which can be used with the signing_algorithm property of a CertificateAuthority.
A constant which can be used with the signing_algorithm property of a CertificateAuthority.
A constant which can be used with the signing_algorithm property of a CertificateAuthority.
A constant which can be used with the signing_algorithm property of a CertificateAuthority.
Gets the certificate_authority_rules of this CertificateAuthority.
Gets the certificate_revocation_list_details of this CertificateAuthority.
[Required] Gets the compartment_id of this CertificateAuthority.
[Required] Gets the config_type of this CertificateAuthority.
Gets the current_version of this CertificateAuthority.
Gets the defined_tags of this CertificateAuthority.
Gets the description of this CertificateAuthority.
Gets the external_key_description of this CertificateAuthority.
Gets the freeform_tags of this CertificateAuthority.
[Required] Gets the id of this CertificateAuthority.
Gets the issuer_certificate_authority_id of this CertificateAuthority.
Gets the kms_key_id of this CertificateAuthority.
Gets the lifecycle_details of this CertificateAuthority.
[Required] Gets the lifecycle_state of this CertificateAuthority.
[Required] Gets the name of this CertificateAuthority.
Gets the signing_algorithm of this CertificateAuthority.
Gets the subject of this CertificateAuthority.
[Required] Gets the time_created of this CertificateAuthority.
Gets the time_of_deletion of this CertificateAuthority.
Methods:
__init__(**kwargs)Initializes a new CertificateAuthority 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a CertificateAuthority. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a CertificateAuthority. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. 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 CertificateAuthority. This constant has a value of “SHA512_WITH_RSA”
- __init__(**kwargs)¶
Initializes a new CertificateAuthority 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 CertificateAuthority.
issuer_certificate_authority_id (str) – The value to assign to the issuer_certificate_authority_id property of this CertificateAuthority.
name (str) – The value to assign to the name property of this CertificateAuthority.
description (str) – The value to assign to the description property of this CertificateAuthority.
external_key_description (str) – The value to assign to the external_key_description property of this CertificateAuthority.
time_created (datetime) – The value to assign to the time_created property of this CertificateAuthority.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this CertificateAuthority.
kms_key_id (str) – The value to assign to the kms_key_id property of this CertificateAuthority.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CertificateAuthority. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this CertificateAuthority.
compartment_id (str) – The value to assign to the compartment_id property of this CertificateAuthority.
certificate_authority_rules (list[oci.certificates_management.models.CertificateAuthorityRule]) – The value to assign to the certificate_authority_rules property of this CertificateAuthority.
current_version (oci.certificates_management.models.CertificateAuthorityVersionSummary) – The value to assign to the current_version property of this CertificateAuthority.
certificate_revocation_list_details (oci.certificates_management.models.CertificateRevocationListDetails) – The value to assign to the certificate_revocation_list_details property of this CertificateAuthority.
config_type (str) – The value to assign to the config_type property of this CertificateAuthority. 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’.
subject (oci.certificates_management.models.CertificateSubject) – The value to assign to the subject property of this CertificateAuthority.
signing_algorithm (str) – The value to assign to the signing_algorithm property of this CertificateAuthority. 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 CertificateAuthority.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CertificateAuthority.
- property certificate_authority_rules¶
Gets the certificate_authority_rules of this CertificateAuthority. An optional list of rules that control how the CA is used and managed.
- Returns
The certificate_authority_rules of this CertificateAuthority.
- Return type
list[oci.certificates_management.models.CertificateAuthorityRule]
- property certificate_revocation_list_details¶
Gets the certificate_revocation_list_details of this CertificateAuthority.
- Returns
The certificate_revocation_list_details of this CertificateAuthority.
- Return type
oci.certificates_management.models.CertificateRevocationListDetails
- property compartment_id¶
[Required] Gets the compartment_id of this CertificateAuthority. The OCID of the compartment under which the CA is created.
- Returns
The compartment_id of this CertificateAuthority.
- Return type
str
- property config_type¶
[Required] Gets the config_type of this CertificateAuthority. 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 CertificateAuthority.
- Return type
str
- property current_version¶
Gets the current_version of this CertificateAuthority.
- Returns
The current_version of this CertificateAuthority.
- Return type
oci.certificates_management.models.CertificateAuthorityVersionSummary
- property defined_tags¶
Gets the defined_tags of this CertificateAuthority. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this CertificateAuthority.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CertificateAuthority. A brief description of the CA.
- Returns
The description of this CertificateAuthority.
- Return type
str
- property external_key_description¶
Gets the external_key_description of this CertificateAuthority. For externally managed CAs, a description of the externally managed key. Avoid entering confidential information.
- Returns
The external_key_description of this CertificateAuthority.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CertificateAuthority. 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 CertificateAuthority.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this CertificateAuthority. The OCID of the CA.
- Returns
The id of this CertificateAuthority.
- Return type
str
- property issuer_certificate_authority_id¶
Gets the issuer_certificate_authority_id of this CertificateAuthority. The OCID of the parent CA that issued this CA. If this is the root CA, then this value is null.
- Returns
The issuer_certificate_authority_id of this CertificateAuthority.
- Return type
str
- property kms_key_id¶
Gets the kms_key_id of this CertificateAuthority. The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt the CA.
- Returns
The kms_key_id of this CertificateAuthority.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this CertificateAuthority. Additional information about the current CA lifecycle state.
- Returns
The lifecycle_details of this CertificateAuthority.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this CertificateAuthority. The current lifecycle state of the certificate authority.
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 CertificateAuthority.
- Return type
str
- property name¶
[Required] Gets the name of this CertificateAuthority. 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 CertificateAuthority.
- Return type
str
- property signing_algorithm¶
Gets the signing_algorithm of this CertificateAuthority. 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 CertificateAuthority.
- Return type
str
- property subject¶
Gets the subject of this CertificateAuthority.
- Returns
The subject of this CertificateAuthority.
- Return type