ibm.getSmPrivateCertificate

func LookupSmPrivateCertificate(ctx *Context, args *LookupSmPrivateCertificateArgs, opts ...InvokeOption) (*LookupSmPrivateCertificateResult, error)
func LookupSmPrivateCertificateOutput(ctx *Context, args *LookupSmPrivateCertificateOutputArgs, opts ...InvokeOption) LookupSmPrivateCertificateResultOutput

> Note: This function is named LookupSmPrivateCertificate in the Go SDK.

InstanceId string

The GUID of the Secrets Manager instance.

EndpointType string

The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

• Constraints: Allowable values are: private, public.

Id string

The unique identifier of the data source.

Name string

The human-readable name of your secret. To be used in combination with secret_group_name.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.

Region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

SecretGroupName string

The name of your existing secret group. To be used in combination with name.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

SecretId string

The ID of the secret.

• Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

InstanceId string

The GUID of the Secrets Manager instance.

EndpointType string

The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

• Constraints: Allowable values are: private, public.

Id string

The unique identifier of the data source.

Name string

The human-readable name of your secret. To be used in combination with secret_group_name.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.

Region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

SecretGroupName string

The name of your existing secret group. To be used in combination with name.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

SecretId string

The ID of the secret.

• Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

instanceId String

The GUID of the Secrets Manager instance.

endpointType String

The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

• Constraints: Allowable values are: private, public.

id String

The unique identifier of the data source.

name String

The human-readable name of your secret. To be used in combination with secret_group_name.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.

region String

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

secretGroupName String

The name of your existing secret group. To be used in combination with name.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

secretId String

The ID of the secret.

• Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

instanceId string

The GUID of the Secrets Manager instance.

endpointType string

The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

• Constraints: Allowable values are: private, public.

id string

The unique identifier of the data source.

name string

The human-readable name of your secret. To be used in combination with secret_group_name.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.

region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

secretGroupName string

The name of your existing secret group. To be used in combination with name.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

secretId string

The ID of the secret.

• Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

instance_id str

The GUID of the Secrets Manager instance.

endpoint_type str

The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

• Constraints: Allowable values are: private, public.

id str

The unique identifier of the data source.

name str

The human-readable name of your secret. To be used in combination with secret_group_name.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.

region str

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

secret_group_name str

The name of your existing secret group. To be used in combination with name.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

secret_id str

The ID of the secret.

• Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

instanceId String

The GUID of the Secrets Manager instance.

endpointType String

The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

• Constraints: Allowable values are: private, public.

id String

The unique identifier of the data source.

name String

The human-readable name of your secret. To be used in combination with secret_group_name.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.

region String

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

secretGroupName String

The name of your existing secret group. To be used in combination with name.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

secretId String

The ID of the secret.

• Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

AltNames List<string>

(List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

• Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.

CaChains List<string>

(List) The chain of certificate authorities that are associated with the certificate.

• Constraints: The list items must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/. The maximum length is 16 items. The minimum length is 1 item.

Certificate string

(String) The PEM-encoded contents of your certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

CertificateAuthority string

(String) The intermediate certificate authority that signed this certificate.

CertificateTemplate string

(String) The name of the certificate template.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.

CommonName string

(String) The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters. The value must match regular expression /(.*?)/.

CreatedAt string

(String) The date when a resource was created. The date format follows RFC 3339.

CreatedBy string

(String) The unique identifier that is associated with the entity that created the secret.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

Crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

• Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

CustomMetadata Dictionary<string, string>

(Map) The secret metadata that a user can customize.

Description string

(String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

• Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

Downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

ExpirationDate string

(String) The date a secret is expired. The date format follows RFC 3339.

Id string

The unique identifier of the data source.

InstanceId string

Issuer string

(String) The distinguished name that identifies the entity that signed and issued the certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

IssuingCa string

(String) The PEM-encoded certificate of the certificate authority that signed and issued this certificate.

• Constraints: The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

KeyAlgorithm string

(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

• Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

Labels List<string>

(List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

• Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

LocksTotal double

(Integer) The number of locks of the secret.

• Constraints: The maximum value is 1000. The minimum value is 0.

Name string

(String) The human-readable name of your secret.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters.

NextRotationDate string

(String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

PrivateKey string

(String) (Optional) The PEM-encoded private key to associate with the certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

Region string

RevocationTimeRfc3339 string

(String) The date and time that the certificate was revoked. The date format follows RFC 3339.

RevocationTimeSeconds double

(Integer) The timestamp of the certificate revocation.

Rotations List<GetSmPrivateCertificateRotation>

(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

SecretGroupId string

(String) A UUID identifier, or default secret group.

• Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

SecretId string

SecretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

• Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

SerialNumber string

(String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.

SigningAlgorithm string

(String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

• Constraints: The maximum length is 64 characters. The minimum length is 4 characters.

State double

(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

• Constraints: Allowable values are: 0, 1, 2, 3, 5.

StateDescription string

(String) A text representation of the secret state.

• Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.

UpdatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

Validities List<GetSmPrivateCertificateValidity>

(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:

VersionsTotal double

(Integer) The number of versions of the secret.

• Constraints: The maximum value is 50. The minimum value is 0.

EndpointType string

SecretGroupName string

AltNames []string

(List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

• Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.

CaChains []string

(List) The chain of certificate authorities that are associated with the certificate.

• Constraints: The list items must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/. The maximum length is 16 items. The minimum length is 1 item.

Certificate string

(String) The PEM-encoded contents of your certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

CertificateAuthority string

(String) The intermediate certificate authority that signed this certificate.

CertificateTemplate string

(String) The name of the certificate template.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.

CommonName string

(String) The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters. The value must match regular expression /(.*?)/.

CreatedAt string

(String) The date when a resource was created. The date format follows RFC 3339.

CreatedBy string

(String) The unique identifier that is associated with the entity that created the secret.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

Crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

• Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

CustomMetadata map[string]string

(Map) The secret metadata that a user can customize.

Description string

(String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

• Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

Downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

ExpirationDate string

(String) The date a secret is expired. The date format follows RFC 3339.

Id string

The unique identifier of the data source.

InstanceId string

Issuer string

(String) The distinguished name that identifies the entity that signed and issued the certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

IssuingCa string

(String) The PEM-encoded certificate of the certificate authority that signed and issued this certificate.

• Constraints: The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

KeyAlgorithm string

(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

• Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

Labels []string

(List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

• Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

LocksTotal float64

(Integer) The number of locks of the secret.

• Constraints: The maximum value is 1000. The minimum value is 0.

Name string

(String) The human-readable name of your secret.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters.

NextRotationDate string

(String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

PrivateKey string

(String) (Optional) The PEM-encoded private key to associate with the certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

Region string

RevocationTimeRfc3339 string

(String) The date and time that the certificate was revoked. The date format follows RFC 3339.

RevocationTimeSeconds float64

(Integer) The timestamp of the certificate revocation.

Rotations []GetSmPrivateCertificateRotation

(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

SecretGroupId string

(String) A UUID identifier, or default secret group.

• Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

SecretId string

SecretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

• Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

SerialNumber string

(String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.

SigningAlgorithm string

(String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

• Constraints: The maximum length is 64 characters. The minimum length is 4 characters.

State float64

(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

• Constraints: Allowable values are: 0, 1, 2, 3, 5.

StateDescription string

(String) A text representation of the secret state.

• Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.

UpdatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

Validities []GetSmPrivateCertificateValidity

(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:

VersionsTotal float64

(Integer) The number of versions of the secret.

• Constraints: The maximum value is 50. The minimum value is 0.

EndpointType string

SecretGroupName string

altNames List<String>

(List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

• Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.

caChains List<String>

(List) The chain of certificate authorities that are associated with the certificate.

• Constraints: The list items must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/. The maximum length is 16 items. The minimum length is 1 item.

certificate String

(String) The PEM-encoded contents of your certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

certificateAuthority String

(String) The intermediate certificate authority that signed this certificate.

certificateTemplate String

(String) The name of the certificate template.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.

commonName String

(String) The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters. The value must match regular expression /(.*?)/.

createdAt String

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy String

(String) The unique identifier that is associated with the entity that created the secret.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn String

(String) A CRN that uniquely identifies an IBM Cloud resource.

• Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

customMetadata Map<String,String>

(Map) The secret metadata that a user can customize.

description String

(String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

• Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

downloaded Boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

expirationDate String

(String) The date a secret is expired. The date format follows RFC 3339.

id String

The unique identifier of the data source.

instanceId String

issuer String

(String) The distinguished name that identifies the entity that signed and issued the certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

issuingCa String

(String) The PEM-encoded certificate of the certificate authority that signed and issued this certificate.

• Constraints: The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

keyAlgorithm String

(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

• Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

labels List<String>

(List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

• Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

locksTotal Double

(Integer) The number of locks of the secret.

• Constraints: The maximum value is 1000. The minimum value is 0.

name String

(String) The human-readable name of your secret.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters.

nextRotationDate String

(String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

privateKey String

(String) (Optional) The PEM-encoded private key to associate with the certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

region String

revocationTimeRfc3339 String

(String) The date and time that the certificate was revoked. The date format follows RFC 3339.

revocationTimeSeconds Double

(Integer) The timestamp of the certificate revocation.

rotations List<GetSmPrivateCertificateRotation>

(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId String

(String) A UUID identifier, or default secret group.

• Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

secretId String

secretType String

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

• Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

serialNumber String

(String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.

signingAlgorithm String

(String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

• Constraints: The maximum length is 64 characters. The minimum length is 4 characters.

state Double

(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

• Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription String

(String) A text representation of the secret state.

• Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.

updatedAt String

(String) The date when a resource was recently modified. The date format follows RFC 3339.

validities List<GetSmPrivateCertificateValidity>

(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:

versionsTotal Double

(Integer) The number of versions of the secret.

• Constraints: The maximum value is 50. The minimum value is 0.

endpointType String

secretGroupName String

altNames string[]

(List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

• Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.

caChains string[]

(List) The chain of certificate authorities that are associated with the certificate.

• Constraints: The list items must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/. The maximum length is 16 items. The minimum length is 1 item.

certificate string

(String) The PEM-encoded contents of your certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

certificateAuthority string

(String) The intermediate certificate authority that signed this certificate.

certificateTemplate string

(String) The name of the certificate template.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.

commonName string

(String) The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters. The value must match regular expression /(.*?)/.

createdAt string

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy string

(String) The unique identifier that is associated with the entity that created the secret.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

• Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

customMetadata {[key: string]: string}

(Map) The secret metadata that a user can customize.

description string

(String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

• Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

downloaded boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

expirationDate string

(String) The date a secret is expired. The date format follows RFC 3339.

id string

The unique identifier of the data source.

instanceId string

issuer string

(String) The distinguished name that identifies the entity that signed and issued the certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

issuingCa string

(String) The PEM-encoded certificate of the certificate authority that signed and issued this certificate.

• Constraints: The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

keyAlgorithm string

(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

• Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

labels string[]

(List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

• Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

locksTotal number

(Integer) The number of locks of the secret.

• Constraints: The maximum value is 1000. The minimum value is 0.

name string

(String) The human-readable name of your secret.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters.

nextRotationDate string

(String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

privateKey string

(String) (Optional) The PEM-encoded private key to associate with the certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

region string

revocationTimeRfc3339 string

(String) The date and time that the certificate was revoked. The date format follows RFC 3339.

revocationTimeSeconds number

(Integer) The timestamp of the certificate revocation.

rotations GetSmPrivateCertificateRotation[]

(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId string

(String) A UUID identifier, or default secret group.

• Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

secretId string

secretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

• Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

serialNumber string

(String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.

signingAlgorithm string

(String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

• Constraints: The maximum length is 64 characters. The minimum length is 4 characters.

state number

(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

• Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription string

(String) A text representation of the secret state.

• Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.

updatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

validities GetSmPrivateCertificateValidity[]

(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:

versionsTotal number

(Integer) The number of versions of the secret.

• Constraints: The maximum value is 50. The minimum value is 0.

endpointType string

secretGroupName string

alt_names Sequence[str]

(List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

• Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.

ca_chains Sequence[str]

(List) The chain of certificate authorities that are associated with the certificate.

• Constraints: The list items must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/. The maximum length is 16 items. The minimum length is 1 item.

certificate str

(String) The PEM-encoded contents of your certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

certificate_authority str

(String) The intermediate certificate authority that signed this certificate.

certificate_template str

(String) The name of the certificate template.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.

common_name str

(String) The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters. The value must match regular expression /(.*?)/.

created_at str

(String) The date when a resource was created. The date format follows RFC 3339.

created_by str

(String) The unique identifier that is associated with the entity that created the secret.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn str

(String) A CRN that uniquely identifies an IBM Cloud resource.

• Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

custom_metadata Mapping[str, str]

(Map) The secret metadata that a user can customize.

description str

(String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

• Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

expiration_date str

(String) The date a secret is expired. The date format follows RFC 3339.

id str

The unique identifier of the data source.

instance_id str

issuer str

(String) The distinguished name that identifies the entity that signed and issued the certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

issuing_ca str

(String) The PEM-encoded certificate of the certificate authority that signed and issued this certificate.

• Constraints: The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

key_algorithm str

(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

• Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

labels Sequence[str]

(List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

• Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

locks_total float

(Integer) The number of locks of the secret.

• Constraints: The maximum value is 1000. The minimum value is 0.

name str

(String) The human-readable name of your secret.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters.

next_rotation_date str

(String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

private_key str

(String) (Optional) The PEM-encoded private key to associate with the certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

region str

revocation_time_rfc3339 str

(String) The date and time that the certificate was revoked. The date format follows RFC 3339.

revocation_time_seconds float

(Integer) The timestamp of the certificate revocation.

rotations Sequence[GetSmPrivateCertificateRotation]

(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secret_group_id str

(String) A UUID identifier, or default secret group.

• Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

secret_id str

secret_type str

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

• Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

serial_number str

(String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.

signing_algorithm str

(String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

• Constraints: The maximum length is 64 characters. The minimum length is 4 characters.

state float

(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

• Constraints: Allowable values are: 0, 1, 2, 3, 5.

state_description str

(String) A text representation of the secret state.

• Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.

updated_at str

(String) The date when a resource was recently modified. The date format follows RFC 3339.

validities Sequence[GetSmPrivateCertificateValidity]

(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:

versions_total float

(Integer) The number of versions of the secret.

• Constraints: The maximum value is 50. The minimum value is 0.

endpoint_type str

secret_group_name str

altNames List<String>

(List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

• Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.

caChains List<String>

(List) The chain of certificate authorities that are associated with the certificate.

• Constraints: The list items must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/. The maximum length is 16 items. The minimum length is 1 item.

certificate String

(String) The PEM-encoded contents of your certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

certificateAuthority String

(String) The intermediate certificate authority that signed this certificate.

certificateTemplate String

(String) The name of the certificate template.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.

commonName String

(String) The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters. The value must match regular expression /(.*?)/.

createdAt String

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy String

(String) The unique identifier that is associated with the entity that created the secret.

• Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn String

(String) A CRN that uniquely identifies an IBM Cloud resource.

• Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

customMetadata Map<String>

(Map) The secret metadata that a user can customize.

description String

(String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

• Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

downloaded Boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

expirationDate String

(String) The date a secret is expired. The date format follows RFC 3339.

id String

The unique identifier of the data source.

instanceId String

issuer String

(String) The distinguished name that identifies the entity that signed and issued the certificate.

• Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

issuingCa String

(String) The PEM-encoded certificate of the certificate authority that signed and issued this certificate.

• Constraints: The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

keyAlgorithm String

(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

• Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.

labels List<String>

(List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

• Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

locksTotal Number

(Integer) The number of locks of the secret.

• Constraints: The maximum value is 1000. The minimum value is 0.

name String

(String) The human-readable name of your secret.

• Constraints: The maximum length is 256 characters. The minimum length is 2 characters.

nextRotationDate String

(String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

privateKey String

(String) (Optional) The PEM-encoded private key to associate with the certificate.

• Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.

region String

revocationTimeRfc3339 String

(String) The date and time that the certificate was revoked. The date format follows RFC 3339.

revocationTimeSeconds Number

(Integer) The timestamp of the certificate revocation.

rotations List<Property Map>

(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId String

(String) A UUID identifier, or default secret group.

• Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

secretId String

secretType String

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

• Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

serialNumber String

(String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

• Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.

signingAlgorithm String

(String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

• Constraints: The maximum length is 64 characters. The minimum length is 4 characters.

state Number

(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

• Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription String

(String) A text representation of the secret state.

• Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.

updatedAt String

(String) The date when a resource was recently modified. The date format follows RFC 3339.

validities List<Property Map>

(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:

versionsTotal Number

(Integer) The number of versions of the secret.

• Constraints: The maximum value is 50. The minimum value is 0.

endpointType String

secretGroupName String

AutoRotate bool

(Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

Interval double

(Integer) The length of the secret rotation time interval.

• Constraints: The minimum value is 1.

Unit string

(String) The units for the secret rotation time interval.

• Constraints: Allowable values are: day, month.

AutoRotate bool

(Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

Interval float64

(Integer) The length of the secret rotation time interval.

• Constraints: The minimum value is 1.

Unit string

(String) The units for the secret rotation time interval.

• Constraints: Allowable values are: day, month.

autoRotate Boolean

(Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

interval Double

(Integer) The length of the secret rotation time interval.

• Constraints: The minimum value is 1.

unit String

(String) The units for the secret rotation time interval.

• Constraints: Allowable values are: day, month.

autoRotate boolean

(Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

interval number

(Integer) The length of the secret rotation time interval.

• Constraints: The minimum value is 1.

unit string

(String) The units for the secret rotation time interval.

• Constraints: Allowable values are: day, month.

auto_rotate bool

(Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

interval float

(Integer) The length of the secret rotation time interval.

• Constraints: The minimum value is 1.

unit str

(String) The units for the secret rotation time interval.

• Constraints: Allowable values are: day, month.

autoRotate Boolean

(Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

interval Number

(Integer) The length of the secret rotation time interval.

• Constraints: The minimum value is 1.

unit String

(String) The units for the secret rotation time interval.

• Constraints: Allowable values are: day, month.

NotAfter string

(String) The date-time format follows RFC 3339.

NotBefore string

(String) The date-time format follows RFC 3339.

NotAfter string

(String) The date-time format follows RFC 3339.

NotBefore string

(String) The date-time format follows RFC 3339.

notAfter String

(String) The date-time format follows RFC 3339.

notBefore String

(String) The date-time format follows RFC 3339.

notAfter string

(String) The date-time format follows RFC 3339.

notBefore string

(String) The date-time format follows RFC 3339.

not_after str

(String) The date-time format follows RFC 3339.

not_before str

(String) The date-time format follows RFC 3339.

notAfter String

(String) The date-time format follows RFC 3339.

notBefore String

(String) The date-time format follows RFC 3339.