Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSmPrivateCertificateMetadata
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getSmPrivateCertificateMetadata

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provides a read-only data source for the metadata of a private certificate. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const privateCertificateMetadata = ibm.getSmPrivateCertificateMetadata({
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    secretId: "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
});
Copy
import pulumi
import pulumi_ibm as ibm

private_certificate_metadata = ibm.get_sm_private_certificate_metadata(instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south",
    secret_id="0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetSmPrivateCertificateMetadata(ctx, &ibm.GetSmPrivateCertificateMetadataArgs{
			InstanceId: ibm_resource_instance.Sm_instance.Guid,
			Region:     pulumi.StringRef("us-south"),
			SecretId:   "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var privateCertificateMetadata = Ibm.GetSmPrivateCertificateMetadata.Invoke(new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        SecretId = "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSmPrivateCertificateMetadataArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var privateCertificateMetadata = IbmFunctions.getSmPrivateCertificateMetadata(GetSmPrivateCertificateMetadataArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .secretId("0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
            .build());

    }
}
Copy
variables:
  privateCertificateMetadata:
    fn::invoke:
      function: ibm:getSmPrivateCertificateMetadata
      arguments:
        instanceId: ${ibm_resource_instance.sm_instance.guid}
        region: us-south
        secretId: 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
Copy

Using getSmPrivateCertificateMetadata

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSmPrivateCertificateMetadata(args: GetSmPrivateCertificateMetadataArgs, opts?: InvokeOptions): Promise<GetSmPrivateCertificateMetadataResult>
function getSmPrivateCertificateMetadataOutput(args: GetSmPrivateCertificateMetadataOutputArgs, opts?: InvokeOptions): Output<GetSmPrivateCertificateMetadataResult>
Copy
def get_sm_private_certificate_metadata(endpoint_type: Optional[str] = None,
                                        id: Optional[str] = None,
                                        instance_id: Optional[str] = None,
                                        region: Optional[str] = None,
                                        secret_id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetSmPrivateCertificateMetadataResult
def get_sm_private_certificate_metadata_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                                        id: Optional[pulumi.Input[str]] = None,
                                        instance_id: Optional[pulumi.Input[str]] = None,
                                        region: Optional[pulumi.Input[str]] = None,
                                        secret_id: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetSmPrivateCertificateMetadataResult]
Copy
func GetSmPrivateCertificateMetadata(ctx *Context, args *GetSmPrivateCertificateMetadataArgs, opts ...InvokeOption) (*GetSmPrivateCertificateMetadataResult, error)
func GetSmPrivateCertificateMetadataOutput(ctx *Context, args *GetSmPrivateCertificateMetadataOutputArgs, opts ...InvokeOption) GetSmPrivateCertificateMetadataResultOutput
Copy

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

public static class GetSmPrivateCertificateMetadata 
{
    public static Task<GetSmPrivateCertificateMetadataResult> InvokeAsync(GetSmPrivateCertificateMetadataArgs args, InvokeOptions? opts = null)
    public static Output<GetSmPrivateCertificateMetadataResult> Invoke(GetSmPrivateCertificateMetadataInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSmPrivateCertificateMetadataResult> getSmPrivateCertificateMetadata(GetSmPrivateCertificateMetadataArgs args, InvokeOptions options)
public static Output<GetSmPrivateCertificateMetadataResult> getSmPrivateCertificateMetadata(GetSmPrivateCertificateMetadataArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getSmPrivateCertificateMetadata:getSmPrivateCertificateMetadata
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
The GUID of the Secrets Manager instance.
SecretId This property is required. 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 This property is required. string
The GUID of the Secrets Manager instance.
SecretId This property is required. 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 This property is required. String
The GUID of the Secrets Manager instance.
secretId This property is required. 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 This property is required. string
The GUID of the Secrets Manager instance.
secretId This property is required. 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 This property is required. str
The GUID of the Secrets Manager instance.
secret_id This property is required. 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 This property is required. String
The GUID of the Secrets Manager instance.
secretId This property is required. 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.

getSmPrivateCertificateMetadata Result

The following output properties are available:

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.
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 /(.*?)/.
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.
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<GetSmPrivateCertificateMetadataRotation>
(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<GetSmPrivateCertificateMetadataValidity>
(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
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.
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 /(.*?)/.
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.
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 []GetSmPrivateCertificateMetadataRotation
(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 []GetSmPrivateCertificateMetadataValidity
(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
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.
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 /(.*?)/.
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.
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<GetSmPrivateCertificateMetadataRotation>
(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<GetSmPrivateCertificateMetadataValidity>
(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
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.
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 /(.*?)/.
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.
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 GetSmPrivateCertificateMetadataRotation[]
(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 GetSmPrivateCertificateMetadataValidity[]
(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
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.
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 /(.*?)/.
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.
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[GetSmPrivateCertificateMetadataRotation]
(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[GetSmPrivateCertificateMetadataValidity]
(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
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.
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 /(.*?)/.
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.
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

Supporting Types

GetSmPrivateCertificateMetadataRotation

AutoRotate This property is required. 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 This property is required. double
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
Unit This property is required. string
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
AutoRotate This property is required. 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 This property is required. float64
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
Unit This property is required. string
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
autoRotate This property is required. 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 This property is required. Double
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
unit This property is required. String
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
autoRotate This property is required. 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 This property is required. number
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
unit This property is required. string
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
auto_rotate This property is required. 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 This property is required. float
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
unit This property is required. str
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
autoRotate This property is required. 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 This property is required. Number
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
unit This property is required. String
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.

GetSmPrivateCertificateMetadataValidity

NotAfter This property is required. string
(String) The date-time format follows RFC 3339.
NotBefore This property is required. string
(String) The date-time format follows RFC 3339.
NotAfter This property is required. string
(String) The date-time format follows RFC 3339.
NotBefore This property is required. string
(String) The date-time format follows RFC 3339.
notAfter This property is required. String
(String) The date-time format follows RFC 3339.
notBefore This property is required. String
(String) The date-time format follows RFC 3339.
notAfter This property is required. string
(String) The date-time format follows RFC 3339.
notBefore This property is required. string
(String) The date-time format follows RFC 3339.
not_after This property is required. str
(String) The date-time format follows RFC 3339.
not_before This property is required. str
(String) The date-time format follows RFC 3339.
notAfter This property is required. String
(String) The date-time format follows RFC 3339.
notBefore This property is required. String
(String) The date-time format follows RFC 3339.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm