ibm.getSmImportedCertificateMetadata

func GetSmImportedCertificateMetadata(ctx *Context, args *GetSmImportedCertificateMetadataArgs, opts ...InvokeOption) (*GetSmImportedCertificateMetadataResult, error)
func GetSmImportedCertificateMetadataOutput(ctx *Context, args *GetSmImportedCertificateMetadataOutputArgs, opts ...InvokeOption) GetSmImportedCertificateMetadataResultOutput

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

InstanceId string

The GUID of the Secrets Manager instance.

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}/.

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.

Region string

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

InstanceId string

The GUID of the Secrets Manager instance.

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}/.

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.

Region string

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

instanceId String

The GUID of the Secrets Manager instance.

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}/.

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.

region String

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

instanceId string

The GUID of the Secrets Manager instance.

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}/.

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.

region string

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

instance_id str

The GUID of the Secrets Manager instance.

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}/.

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.

region str

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

instanceId String

The GUID of the Secrets Manager instance.

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}/.

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.

region String

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

CommonName string

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

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

IntermediateIncluded bool

(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.

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 /(.*?)/.

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.

ManagedCsrs List<GetSmImportedCertificateMetadataManagedCsr>

(List) The data specified to create the CSR and the private key. Nested scheme for managed_csr:

Name string

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

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

PrivateKeyIncluded bool

(Boolean) Indicates whether the certificate was imported with an associated private key.

Region string

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<GetSmImportedCertificateMetadataValidity>

(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

CommonName string

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

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

IntermediateIncluded bool

(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.

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 /(.*?)/.

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.

ManagedCsrs []GetSmImportedCertificateMetadataManagedCsr

(List) The data specified to create the CSR and the private key. Nested scheme for managed_csr:

Name string

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

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

PrivateKeyIncluded bool

(Boolean) Indicates whether the certificate was imported with an associated private key.

Region string

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 []GetSmImportedCertificateMetadataValidity

(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

commonName String

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

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

intermediateIncluded Boolean

(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.

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 /(.*?)/.

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.

managedCsrs List<GetSmImportedCertificateMetadataManagedCsr>

(List) The data specified to create the CSR and the private key. Nested scheme for managed_csr:

name String

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

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

privateKeyIncluded Boolean

(Boolean) Indicates whether the certificate was imported with an associated private key.

region String

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<GetSmImportedCertificateMetadataValidity>

(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

commonName string

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

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

intermediateIncluded boolean

(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.

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 /(.*?)/.

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.

managedCsrs GetSmImportedCertificateMetadataManagedCsr[]

(List) The data specified to create the CSR and the private key. Nested scheme for managed_csr:

name string

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

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

privateKeyIncluded boolean

(Boolean) Indicates whether the certificate was imported with an associated private key.

region string

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 GetSmImportedCertificateMetadataValidity[]

(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

common_name str

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

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

intermediate_included bool

(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.

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 /(.*?)/.

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.

managed_csrs Sequence[GetSmImportedCertificateMetadataManagedCsr]

(List) The data specified to create the CSR and the private key. Nested scheme for managed_csr:

name str

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

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

private_key_included bool

(Boolean) Indicates whether the certificate was imported with an associated private key.

region str

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[GetSmImportedCertificateMetadataValidity]

(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

commonName String

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

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

intermediateIncluded Boolean

(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.

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 /(.*?)/.

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.

managedCsrs List<Property Map>

(List) The data specified to create the CSR and the private key. Nested scheme for managed_csr:

name String

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

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

privateKeyIncluded Boolean

(Boolean) Indicates whether the certificate was imported with an associated private key.

region String

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

AltNames string

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

ClientFlag bool

(Boolean) This field indicates whether certificate is flagged for client use.

CodeSigningFlag bool

( Boolean) This field indicates whether certificate is flagged for code signing use.

CommonName string

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

Countries List<string>

(List) The Country (C) values to define in the subject field of the resulting certificate.

Csr string

(String) The certificate signing request generated based on the parameters in the managed_csr data.

EmailProtectionFlag bool

(String) This field indicates whether certificate is flagged for email protection use.

ExcludeCnFromSans bool

(String) This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).

ExtKeyUsage string

(String) The allowed extended key usage constraint on certificate, in a comma-delimited list.

ExtKeyUsageOids string

(String) A comma-delimited list of extended key usage Object Identifiers (OIDs).

IpSans string

(String) The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.

KeyBits double

(Integer) The number of bits to use to generate the private key.

KeyType string

(String) The type of private key to generate.

KeyUsage string

(String) The allowed key usage constraint to define for certificate, in a comma-delimited list.

Localities List<string>

(List) The Locality (L) values to define in the subject field of the resulting certificate.

Organizations List<string>

(List) The Organization (O) values to define in the subject field of the resulting certificate.

OtherSans string

(String) The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.

Ous List<string>

(List) The Organizational Unit (OU) values to define in the subject field of the resulting certificate.

PolicyIdentifiers string

(String) A comma-delimited list of policy Object Identifiers (OIDs).

PostalCodes List<string>

(List) The postal code values to define in the subject field of the resulting certificate.

Provinces List<string>

(List) The Province (ST) values to define in the subject field of the resulting certificate.

RequireCn bool

(Boolean) If set to false, makes the common_name field optional while generating a certificate.

RotateKeys bool

(Boolean) This field indicates whether the private key will be rotated.

ServerFlag bool

(Boolean) This field indicates whether certificate is flagged for server use.

StreetAddresses List<string>

(List) The street address values to define in the subject field of the resulting certificate.

UriSans string

(String) The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.

UserIds string

(String) Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.

AltNames string

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

ClientFlag bool

(Boolean) This field indicates whether certificate is flagged for client use.

CodeSigningFlag bool

( Boolean) This field indicates whether certificate is flagged for code signing use.

CommonName string

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

Countries []string

(List) The Country (C) values to define in the subject field of the resulting certificate.

Csr string

(String) The certificate signing request generated based on the parameters in the managed_csr data.

EmailProtectionFlag bool

(String) This field indicates whether certificate is flagged for email protection use.

ExcludeCnFromSans bool

(String) This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).

ExtKeyUsage string

(String) The allowed extended key usage constraint on certificate, in a comma-delimited list.

ExtKeyUsageOids string

(String) A comma-delimited list of extended key usage Object Identifiers (OIDs).

IpSans string

(String) The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.

KeyBits float64

(Integer) The number of bits to use to generate the private key.

KeyType string

(String) The type of private key to generate.

KeyUsage string

(String) The allowed key usage constraint to define for certificate, in a comma-delimited list.

Localities []string

(List) The Locality (L) values to define in the subject field of the resulting certificate.

Organizations []string

(List) The Organization (O) values to define in the subject field of the resulting certificate.

OtherSans string

(String) The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.

Ous []string

(List) The Organizational Unit (OU) values to define in the subject field of the resulting certificate.

PolicyIdentifiers string

(String) A comma-delimited list of policy Object Identifiers (OIDs).

PostalCodes []string

(List) The postal code values to define in the subject field of the resulting certificate.

Provinces []string

(List) The Province (ST) values to define in the subject field of the resulting certificate.

RequireCn bool

(Boolean) If set to false, makes the common_name field optional while generating a certificate.

RotateKeys bool

(Boolean) This field indicates whether the private key will be rotated.

ServerFlag bool

(Boolean) This field indicates whether certificate is flagged for server use.

StreetAddresses []string

(List) The street address values to define in the subject field of the resulting certificate.

UriSans string

(String) The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.

UserIds string

(String) Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.

altNames String

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

clientFlag Boolean

(Boolean) This field indicates whether certificate is flagged for client use.

codeSigningFlag Boolean

( Boolean) This field indicates whether certificate is flagged for code signing use.

commonName String

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

countries List<String>

(List) The Country (C) values to define in the subject field of the resulting certificate.

csr String

(String) The certificate signing request generated based on the parameters in the managed_csr data.

emailProtectionFlag Boolean

(String) This field indicates whether certificate is flagged for email protection use.

excludeCnFromSans Boolean

(String) This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).

extKeyUsage String

(String) The allowed extended key usage constraint on certificate, in a comma-delimited list.

extKeyUsageOids String

(String) A comma-delimited list of extended key usage Object Identifiers (OIDs).

ipSans String

(String) The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.

keyBits Double

(Integer) The number of bits to use to generate the private key.

keyType String

(String) The type of private key to generate.

keyUsage String

(String) The allowed key usage constraint to define for certificate, in a comma-delimited list.

localities List<String>

(List) The Locality (L) values to define in the subject field of the resulting certificate.

organizations List<String>

(List) The Organization (O) values to define in the subject field of the resulting certificate.

otherSans String

(String) The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.

ous List<String>

(List) The Organizational Unit (OU) values to define in the subject field of the resulting certificate.

policyIdentifiers String

(String) A comma-delimited list of policy Object Identifiers (OIDs).

postalCodes List<String>

(List) The postal code values to define in the subject field of the resulting certificate.

provinces List<String>

(List) The Province (ST) values to define in the subject field of the resulting certificate.

requireCn Boolean

(Boolean) If set to false, makes the common_name field optional while generating a certificate.

rotateKeys Boolean

(Boolean) This field indicates whether the private key will be rotated.

serverFlag Boolean

(Boolean) This field indicates whether certificate is flagged for server use.

streetAddresses List<String>

(List) The street address values to define in the subject field of the resulting certificate.

uriSans String

(String) The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.

userIds String

(String) Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.

altNames string

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

clientFlag boolean

(Boolean) This field indicates whether certificate is flagged for client use.

codeSigningFlag boolean

( Boolean) This field indicates whether certificate is flagged for code signing use.

commonName string

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

countries string[]

(List) The Country (C) values to define in the subject field of the resulting certificate.

csr string

(String) The certificate signing request generated based on the parameters in the managed_csr data.

emailProtectionFlag boolean

(String) This field indicates whether certificate is flagged for email protection use.

excludeCnFromSans boolean

(String) This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).

extKeyUsage string

(String) The allowed extended key usage constraint on certificate, in a comma-delimited list.

extKeyUsageOids string

(String) A comma-delimited list of extended key usage Object Identifiers (OIDs).

ipSans string

(String) The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.

keyBits number

(Integer) The number of bits to use to generate the private key.

keyType string

(String) The type of private key to generate.

keyUsage string

(String) The allowed key usage constraint to define for certificate, in a comma-delimited list.

localities string[]

(List) The Locality (L) values to define in the subject field of the resulting certificate.

organizations string[]

(List) The Organization (O) values to define in the subject field of the resulting certificate.

otherSans string

(String) The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.

ous string[]

(List) The Organizational Unit (OU) values to define in the subject field of the resulting certificate.

policyIdentifiers string

(String) A comma-delimited list of policy Object Identifiers (OIDs).

postalCodes string[]

(List) The postal code values to define in the subject field of the resulting certificate.

provinces string[]

(List) The Province (ST) values to define in the subject field of the resulting certificate.

requireCn boolean

(Boolean) If set to false, makes the common_name field optional while generating a certificate.

rotateKeys boolean

(Boolean) This field indicates whether the private key will be rotated.

serverFlag boolean

(Boolean) This field indicates whether certificate is flagged for server use.

streetAddresses string[]

(List) The street address values to define in the subject field of the resulting certificate.

uriSans string

(String) The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.

userIds string

(String) Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.

alt_names str

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

client_flag bool

(Boolean) This field indicates whether certificate is flagged for client use.

code_signing_flag bool

( Boolean) This field indicates whether certificate is flagged for code signing use.

common_name str

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

countries Sequence[str]

(List) The Country (C) values to define in the subject field of the resulting certificate.

csr str

(String) The certificate signing request generated based on the parameters in the managed_csr data.

email_protection_flag bool

(String) This field indicates whether certificate is flagged for email protection use.

exclude_cn_from_sans bool

(String) This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).

ext_key_usage str

(String) The allowed extended key usage constraint on certificate, in a comma-delimited list.

ext_key_usage_oids str

(String) A comma-delimited list of extended key usage Object Identifiers (OIDs).

ip_sans str

(String) The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.

key_bits float

(Integer) The number of bits to use to generate the private key.

key_type str

(String) The type of private key to generate.

key_usage str

(String) The allowed key usage constraint to define for certificate, in a comma-delimited list.

localities Sequence[str]

(List) The Locality (L) values to define in the subject field of the resulting certificate.

organizations Sequence[str]

(List) The Organization (O) values to define in the subject field of the resulting certificate.

other_sans str

(String) The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.

ous Sequence[str]

(List) The Organizational Unit (OU) values to define in the subject field of the resulting certificate.

policy_identifiers str

(String) A comma-delimited list of policy Object Identifiers (OIDs).

postal_codes Sequence[str]

(List) The postal code values to define in the subject field of the resulting certificate.

provinces Sequence[str]

(List) The Province (ST) values to define in the subject field of the resulting certificate.

require_cn bool

(Boolean) If set to false, makes the common_name field optional while generating a certificate.

rotate_keys bool

(Boolean) This field indicates whether the private key will be rotated.

server_flag bool

(Boolean) This field indicates whether certificate is flagged for server use.

street_addresses Sequence[str]

(List) The street address values to define in the subject field of the resulting certificate.

uri_sans str

(String) The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.

user_ids str

(String) Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.

altNames String

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

clientFlag Boolean

(Boolean) This field indicates whether certificate is flagged for client use.

codeSigningFlag Boolean

( Boolean) This field indicates whether certificate is flagged for code signing use.

commonName String

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

countries List<String>

(List) The Country (C) values to define in the subject field of the resulting certificate.

csr String

(String) The certificate signing request generated based on the parameters in the managed_csr data.

emailProtectionFlag Boolean

(String) This field indicates whether certificate is flagged for email protection use.

excludeCnFromSans Boolean

(String) This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).

extKeyUsage String

(String) The allowed extended key usage constraint on certificate, in a comma-delimited list.

extKeyUsageOids String

(String) A comma-delimited list of extended key usage Object Identifiers (OIDs).

ipSans String

(String) The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.

keyBits Number

(Integer) The number of bits to use to generate the private key.

keyType String

(String) The type of private key to generate.

keyUsage String

(String) The allowed key usage constraint to define for certificate, in a comma-delimited list.

localities List<String>

(List) The Locality (L) values to define in the subject field of the resulting certificate.

organizations List<String>

(List) The Organization (O) values to define in the subject field of the resulting certificate.

otherSans String

(String) The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.

ous List<String>

(List) The Organizational Unit (OU) values to define in the subject field of the resulting certificate.

policyIdentifiers String

(String) A comma-delimited list of policy Object Identifiers (OIDs).

postalCodes List<String>

(List) The postal code values to define in the subject field of the resulting certificate.

provinces List<String>

(List) The Province (ST) values to define in the subject field of the resulting certificate.

requireCn Boolean

(Boolean) If set to false, makes the common_name field optional while generating a certificate.

rotateKeys Boolean

(Boolean) This field indicates whether the private key will be rotated.

serverFlag Boolean

(Boolean) This field indicates whether certificate is flagged for server use.

streetAddresses List<String>

(List) The street address values to define in the subject field of the resulting certificate.

uriSans String

(String) The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.

userIds String

(String) Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.

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.