Certificate¶
- class oci.certificates_management.models.Certificate(**kwargs)¶
Bases:
objectThe details of the certificate. This object does not contain the certificate contents.
Attributes:
A constant which can be used with the certificate_profile_type property of a Certificate.
A constant which can be used with the certificate_profile_type property of a Certificate.
A constant which can be used with the certificate_profile_type property of a Certificate.
A constant which can be used with the certificate_profile_type property of a Certificate.
A constant which can be used with the config_type property of a Certificate.
A constant which can be used with the config_type property of a Certificate.
A constant which can be used with the config_type property of a Certificate.
A constant which can be used with the key_algorithm property of a Certificate.
A constant which can be used with the key_algorithm property of a Certificate.
A constant which can be used with the key_algorithm property of a Certificate.
A constant which can be used with the key_algorithm property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the lifecycle_state property of a Certificate.
A constant which can be used with the signature_algorithm property of a Certificate.
A constant which can be used with the signature_algorithm property of a Certificate.
A constant which can be used with the signature_algorithm property of a Certificate.
A constant which can be used with the signature_algorithm property of a Certificate.
A constant which can be used with the signature_algorithm property of a Certificate.
A constant which can be used with the signature_algorithm property of a Certificate.
Gets the certificate_profile_type of this Certificate.
Gets the certificate_revocation_list_details of this Certificate.
Gets the certificate_rules of this Certificate.
[Required] Gets the compartment_id of this Certificate.
[Required] Gets the config_type of this Certificate.
Gets the current_version of this Certificate.
Gets the defined_tags of this Certificate.
Gets the description of this Certificate.
Gets the freeform_tags of this Certificate.
[Required] Gets the id of this Certificate.
Gets the issuer_certificate_authority_id of this Certificate.
Gets the key_algorithm of this Certificate.
Gets the lifecycle_details of this Certificate.
[Required] Gets the lifecycle_state of this Certificate.
[Required] Gets the name of this Certificate.
Gets the signature_algorithm of this Certificate.
Gets the subject of this Certificate.
[Required] Gets the time_created of this Certificate.
Gets the time_of_deletion of this Certificate.
Methods:
__init__(**kwargs)Initializes a new Certificate object with values from keyword arguments.
- CERTIFICATE_PROFILE_TYPE_TLS_CLIENT = 'TLS_CLIENT'¶
A constant which can be used with the certificate_profile_type property of a Certificate. This constant has a value of “TLS_CLIENT”
- CERTIFICATE_PROFILE_TYPE_TLS_CODE_SIGN = 'TLS_CODE_SIGN'¶
A constant which can be used with the certificate_profile_type property of a Certificate. This constant has a value of “TLS_CODE_SIGN”
- CERTIFICATE_PROFILE_TYPE_TLS_SERVER = 'TLS_SERVER'¶
A constant which can be used with the certificate_profile_type property of a Certificate. This constant has a value of “TLS_SERVER”
- CERTIFICATE_PROFILE_TYPE_TLS_SERVER_OR_CLIENT = 'TLS_SERVER_OR_CLIENT'¶
A constant which can be used with the certificate_profile_type property of a Certificate. This constant has a value of “TLS_SERVER_OR_CLIENT”
- CONFIG_TYPE_IMPORTED = 'IMPORTED'¶
A constant which can be used with the config_type property of a Certificate. This constant has a value of “IMPORTED”
- CONFIG_TYPE_ISSUED_BY_INTERNAL_CA = 'ISSUED_BY_INTERNAL_CA'¶
A constant which can be used with the config_type property of a Certificate. This constant has a value of “ISSUED_BY_INTERNAL_CA”
- CONFIG_TYPE_MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA = 'MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA'¶
A constant which can be used with the config_type property of a Certificate. This constant has a value of “MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA”
- KEY_ALGORITHM_ECDSA_P256 = 'ECDSA_P256'¶
A constant which can be used with the key_algorithm property of a Certificate. This constant has a value of “ECDSA_P256”
- KEY_ALGORITHM_ECDSA_P384 = 'ECDSA_P384'¶
A constant which can be used with the key_algorithm property of a Certificate. This constant has a value of “ECDSA_P384”
- KEY_ALGORITHM_RSA2048 = 'RSA2048'¶
A constant which can be used with the key_algorithm property of a Certificate. This constant has a value of “RSA2048”
- KEY_ALGORITHM_RSA4096 = 'RSA4096'¶
A constant which can be used with the key_algorithm property of a Certificate. This constant has a value of “RSA4096”
- 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_CANCELLING_DELETION = 'CANCELLING_DELETION'¶
A constant which can be used with the lifecycle_state property of a Certificate. 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 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_PENDING_DELETION = 'PENDING_DELETION'¶
A constant which can be used with the lifecycle_state property of a Certificate. 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 Certificate. 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 Certificate. This constant has a value of “UPDATING”
- SIGNATURE_ALGORITHM_SHA256_WITH_ECDSA = 'SHA256_WITH_ECDSA'¶
A constant which can be used with the signature_algorithm property of a Certificate. This constant has a value of “SHA256_WITH_ECDSA”
- SIGNATURE_ALGORITHM_SHA256_WITH_RSA = 'SHA256_WITH_RSA'¶
A constant which can be used with the signature_algorithm property of a Certificate. This constant has a value of “SHA256_WITH_RSA”
- SIGNATURE_ALGORITHM_SHA384_WITH_ECDSA = 'SHA384_WITH_ECDSA'¶
A constant which can be used with the signature_algorithm property of a Certificate. This constant has a value of “SHA384_WITH_ECDSA”
- SIGNATURE_ALGORITHM_SHA384_WITH_RSA = 'SHA384_WITH_RSA'¶
A constant which can be used with the signature_algorithm property of a Certificate. This constant has a value of “SHA384_WITH_RSA”
- SIGNATURE_ALGORITHM_SHA512_WITH_ECDSA = 'SHA512_WITH_ECDSA'¶
A constant which can be used with the signature_algorithm property of a Certificate. This constant has a value of “SHA512_WITH_ECDSA”
- SIGNATURE_ALGORITHM_SHA512_WITH_RSA = 'SHA512_WITH_RSA'¶
A constant which can be used with the signature_algorithm property of a Certificate. This constant has a value of “SHA512_WITH_RSA”
- __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.
issuer_certificate_authority_id (str) – The value to assign to the issuer_certificate_authority_id property of this Certificate.
name (str) – The value to assign to the name property of this Certificate.
description (str) – The value to assign to the description property of this Certificate.
certificate_rules (list[oci.certificates_management.models.CertificateRule]) – The value to assign to the certificate_rules property of this Certificate.
time_created (datetime) – The value to assign to the time_created property of this Certificate.
time_of_deletion (datetime) – The value to assign to the time_of_deletion 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”, “SCHEDULING_DELETION”, “PENDING_DELETION”, “CANCELLING_DELETION”, “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.
compartment_id (str) – The value to assign to the compartment_id property of this Certificate.
current_version (oci.certificates_management.models.CertificateVersionSummary) – The value to assign to the current_version property of this Certificate.
subject (oci.certificates_management.models.CertificateSubject) – The value to assign to the subject property of this Certificate.
certificate_revocation_list_details (oci.certificates_management.models.CertificateRevocationListDetails) – The value to assign to the certificate_revocation_list_details property of this Certificate.
config_type (str) – The value to assign to the config_type property of this Certificate. Allowed values for this property are: “ISSUED_BY_INTERNAL_CA”, “MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA”, “IMPORTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
key_algorithm (str) – The value to assign to the key_algorithm property of this Certificate. Allowed values for this property are: “RSA2048”, “RSA4096”, “ECDSA_P256”, “ECDSA_P384”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
signature_algorithm (str) – The value to assign to the signature_algorithm property of this Certificate. 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’.
certificate_profile_type (str) – The value to assign to the certificate_profile_type property of this Certificate. Allowed values for this property are: “TLS_SERVER_OR_CLIENT”, “TLS_SERVER”, “TLS_CLIENT”, “TLS_CODE_SIGN”, ‘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 Certificate.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Certificate.
- property certificate_profile_type¶
Gets the certificate_profile_type of this Certificate. The name of the profile used to create the certificate, which depends on the type of certificate you need.
Allowed values for this property are: “TLS_SERVER_OR_CLIENT”, “TLS_SERVER”, “TLS_CLIENT”, “TLS_CODE_SIGN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The certificate_profile_type of this Certificate.
- Return type
str
- property certificate_revocation_list_details¶
Gets the certificate_revocation_list_details of this Certificate.
- Returns
The certificate_revocation_list_details of this Certificate.
- Return type
oci.certificates_management.models.CertificateRevocationListDetails
- property certificate_rules¶
Gets the certificate_rules of this Certificate. A list of rules that control how the certificate is used and managed.
- Returns
The certificate_rules of this Certificate.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this Certificate. The OCID of the compartment where you want to create the certificate.
- Returns
The compartment_id of this Certificate.
- Return type
str
- property config_type¶
[Required] Gets the config_type of this Certificate. The origin of the certificate.
Allowed values for this property are: “ISSUED_BY_INTERNAL_CA”, “MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA”, “IMPORTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The config_type of this Certificate.
- Return type
str
- property current_version¶
Gets the current_version of this Certificate.
- Returns
The current_version of this Certificate.
- Return type
oci.certificates_management.models.CertificateVersionSummary
- 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 description¶
Gets the description of this Certificate. A brief description of the certificate. Avoid entering confidential information.
- Returns
The description 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 certificate.
- Returns
The id of this Certificate.
- Return type
str
- property issuer_certificate_authority_id¶
Gets the issuer_certificate_authority_id of this Certificate. The OCID of the certificate authority (CA) that issued the certificate.
- Returns
The issuer_certificate_authority_id of this Certificate.
- Return type
str
- property key_algorithm¶
Gets the key_algorithm of this Certificate. The algorithm used to create key pairs.
Allowed values for this property are: “RSA2048”, “RSA4096”, “ECDSA_P256”, “ECDSA_P384”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The key_algorithm of this Certificate.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this Certificate. Additional information about the current lifecycle state of the certificate.
- Returns
The lifecycle_details of this Certificate.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Certificate. The current lifecycle state of the certificate.
Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “SCHEDULING_DELETION”, “PENDING_DELETION”, “CANCELLING_DELETION”, “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 name¶
[Required] Gets the name of this Certificate. A user-friendly name for the certificate. Names are unique within a compartment. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
- Returns
The name of this Certificate.
- Return type
str
- property signature_algorithm¶
Gets the signature_algorithm of this Certificate. The algorithm used to sign the public key certificate.
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 signature_algorithm of this Certificate.
- Return type
str
- property subject¶
Gets the subject of this Certificate.
- Returns
The subject of this Certificate.
- Return type