Reference documentation and code samples for the Ceritificate Authority Service V1 API class Google::Cloud::Security::PrivateCA::V1::CertificateTemplate.
A CertificateTemplate refers to a managed template for certificate issuance.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this CertificateTemplate was created.
#description
def description() -> ::String
Returns
- (::String) — Optional. A human-readable description of scenarios this template is intended for.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. A human-readable description of scenarios this template is intended for.
Returns
- (::String) — Optional. A human-readable description of scenarios this template is intended for.
#identity_constraints
def identity_constraints() -> ::Google::Cloud::Security::PrivateCA::V1::CertificateIdentityConstraints
Returns
- (::Google::Cloud::Security::PrivateCA::V1::CertificateIdentityConstraints) — Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity.
#identity_constraints=
def identity_constraints=(value) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateIdentityConstraints
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1::CertificateIdentityConstraints) — Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity.
Returns
- (::Google::Cloud::Security::PrivateCA::V1::CertificateIdentityConstraints) — Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels with user-defined metadata.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels with user-defined metadata.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels with user-defined metadata.
#maximum_lifetime
def maximum_lifetime() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — Optional. The maximum lifetime allowed for issued Certificates that use this template. If the issuing CaPool's IssuancePolicy specifies a maximum_lifetime the minimum of the two durations will be the maximum lifetime for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it.
#maximum_lifetime=
def maximum_lifetime=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — Optional. The maximum lifetime allowed for issued Certificates that use this template. If the issuing CaPool's IssuancePolicy specifies a maximum_lifetime the minimum of the two durations will be the maximum lifetime for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it.
Returns
- (::Google::Protobuf::Duration) — Optional. The maximum lifetime allowed for issued Certificates that use this template. If the issuing CaPool's IssuancePolicy specifies a maximum_lifetime the minimum of the two durations will be the maximum lifetime for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name for this
CertificateTemplate
in the format
projects/*/locations/*/certificateTemplates/*.
#passthrough_extensions
def passthrough_extensions() -> ::Google::Cloud::Security::PrivateCA::V1::CertificateExtensionConstraints
Returns
- (::Google::Cloud::Security::PrivateCA::V1::CertificateExtensionConstraints) — Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines baseline_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this template will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CertificateTemplate's predefined_values.
#passthrough_extensions=
def passthrough_extensions=(value) -> ::Google::Cloud::Security::PrivateCA::V1::CertificateExtensionConstraints
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1::CertificateExtensionConstraints) — Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines baseline_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this template will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CertificateTemplate's predefined_values.
Returns
- (::Google::Cloud::Security::PrivateCA::V1::CertificateExtensionConstraints) — Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines baseline_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this template will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CertificateTemplate's predefined_values.
#predefined_values
def predefined_values() -> ::Google::Cloud::Security::PrivateCA::V1::X509Parameters
Returns
- (::Google::Cloud::Security::PrivateCA::V1::X509Parameters) — Optional. A set of X.509 values that will be applied to all issued certificates that use this template. If the certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If the issuing CaPool's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail.
#predefined_values=
def predefined_values=(value) -> ::Google::Cloud::Security::PrivateCA::V1::X509Parameters
Parameter
- value (::Google::Cloud::Security::PrivateCA::V1::X509Parameters) — Optional. A set of X.509 values that will be applied to all issued certificates that use this template. If the certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If the issuing CaPool's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail.
Returns
- (::Google::Cloud::Security::PrivateCA::V1::X509Parameters) — Optional. A set of X.509 values that will be applied to all issued certificates that use this template. If the certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If the issuing CaPool's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which this CertificateTemplate was updated.