secretsmanagerv1

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2023 License: Apache-2.0 Imports: 10 Imported by: 4

Documentation

Overview

Package secretsmanagerv1 : Operations and models for the SecretsManagerV1 service

Index

Constants

View Source
const (
	ActionOnConfigElementOptionsConfigElementIntermediateCertificateAuthoritiesConst = "intermediate_certificate_authorities"
	ActionOnConfigElementOptionsConfigElementRootCertificateAuthoritiesConst         = "root_certificate_authorities"
)

Constants associated with the ActionOnConfigElementOptions.ConfigElement property. The configuration element on which the action is applied.

View Source
const (
	ActionOnConfigElementOptionsActionRevokeConst           = "revoke"
	ActionOnConfigElementOptionsActionRotateCrlConst        = "rotate_crl"
	ActionOnConfigElementOptionsActionSetSignedConst        = "set_signed"
	ActionOnConfigElementOptionsActionSignCsrConst          = "sign_csr"
	ActionOnConfigElementOptionsActionSignIntermediateConst = "sign_intermediate"
)

Constants associated with the ActionOnConfigElementOptions.Action property. The action to perform on the specified configuration element.

View Source
const (
	CertificateTemplatesConfigItemTypeCertificateTemplateConst              = "certificate_template"
	CertificateTemplatesConfigItemTypeCisConst                              = "cis"
	CertificateTemplatesConfigItemTypeClassicInfrastructureConst            = "classic_infrastructure"
	CertificateTemplatesConfigItemTypeIntermediateCertificateAuthorityConst = "intermediate_certificate_authority"
	CertificateTemplatesConfigItemTypeLetsencryptConst                      = "letsencrypt"
	CertificateTemplatesConfigItemTypeLetsencryptStageConst                 = "letsencrypt-stage"
	CertificateTemplatesConfigItemTypeRootCertificateAuthorityConst         = "root_certificate_authority"
)

Constants associated with the CertificateTemplatesConfigItem.Type property. The type of configuration. Value options differ depending on the `config_element` property that you want to define.

View Source
const (
	CollectionMetadataCollectionTypeApplicationVndIBMSecretsManagerConfigJSONConst        = "application/vnd.ibm.secrets-manager.config+json"
	CollectionMetadataCollectionTypeApplicationVndIBMSecretsManagerErrorJSONConst         = "application/vnd.ibm.secrets-manager.error+json"
	CollectionMetadataCollectionTypeApplicationVndIBMSecretsManagerSecretGroupJSONConst   = "application/vnd.ibm.secrets-manager.secret.group+json"
	CollectionMetadataCollectionTypeApplicationVndIBMSecretsManagerSecretJSONConst        = "application/vnd.ibm.secrets-manager.secret+json"
	CollectionMetadataCollectionTypeApplicationVndIBMSecretsManagerSecretLockJSONConst    = "application/vnd.ibm.secrets-manager.secret.lock+json"
	CollectionMetadataCollectionTypeApplicationVndIBMSecretsManagerSecretPolicyJSONConst  = "application/vnd.ibm.secrets-manager.secret.policy+json"
	CollectionMetadataCollectionTypeApplicationVndIBMSecretsManagerSecretVersionJSONConst = "application/vnd.ibm.secrets-manager.secret.version+json"
)

Constants associated with the CollectionMetadata.CollectionType property. The type of resources in the resource array.

View Source
const (
	ConfigActionFormatPemConst       = "pem"
	ConfigActionFormatPemBundleConst = "pem_bundle"
)

Constants associated with the ConfigAction.Format property. The format of the returned data.

View Source
const (
	ConfigElementActionDataTypeCertificateTemplateConst              = "certificate_template"
	ConfigElementActionDataTypeCisConst                              = "cis"
	ConfigElementActionDataTypeClassicInfrastructureConst            = "classic_infrastructure"
	ConfigElementActionDataTypeIntermediateCertificateAuthorityConst = "intermediate_certificate_authority"
	ConfigElementActionDataTypeLetsencryptConst                      = "letsencrypt"
	ConfigElementActionDataTypeLetsencryptStageConst                 = "letsencrypt-stage"
	ConfigElementActionDataTypeRootCertificateAuthorityConst         = "root_certificate_authority"
)

Constants associated with the ConfigElementActionData.Type property. The type of configuration. Value options differ depending on the `config_element` property that you want to define.

View Source
const (
	ConfigElementActionResultConfigFormatPemConst       = "pem"
	ConfigElementActionResultConfigFormatPemBundleConst = "pem_bundle"
)

Constants associated with the ConfigElementActionResultConfig.Format property. The format of the returned data.

View Source
const (
	ConfigElementDefTypeCertificateTemplateConst              = "certificate_template"
	ConfigElementDefTypeCisConst                              = "cis"
	ConfigElementDefTypeClassicInfrastructureConst            = "classic_infrastructure"
	ConfigElementDefTypeIntermediateCertificateAuthorityConst = "intermediate_certificate_authority"
	ConfigElementDefTypeLetsencryptConst                      = "letsencrypt"
	ConfigElementDefTypeLetsencryptStageConst                 = "letsencrypt-stage"
	ConfigElementDefTypeRootCertificateAuthorityConst         = "root_certificate_authority"
)

Constants associated with the ConfigElementDef.Type property. The type of configuration. Value options differ depending on the `config_element` property that you want to define.

View Source
const (
	ConfigElementDefConfigStatusCertificateTemplateRequiredConst = "certificate_template_required"
	ConfigElementDefConfigStatusConfiguredConst                  = "configured"
	ConfigElementDefConfigStatusExpiredConst                     = "expired"
	ConfigElementDefConfigStatusRevokedConst                     = "revoked"
	ConfigElementDefConfigStatusSignedCertificateRequiredConst   = "signed_certificate_required"
	ConfigElementDefConfigStatusSigningRequiredConst             = "signing_required"
)

Constants associated with the ConfigElementDefConfig.Status property. The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`, `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.

View Source
const (
	ConfigElementDefConfigFormatPemConst       = "pem"
	ConfigElementDefConfigFormatPemBundleConst = "pem_bundle"
)

Constants associated with the ConfigElementDefConfig.Format property. The format of the returned data.

View Source
const (
	ConfigElementDefConfigPrivateKeyFormatDerConst   = "der"
	ConfigElementDefConfigPrivateKeyFormatPkcs8Const = "pkcs8"
)

Constants associated with the ConfigElementDefConfig.PrivateKeyFormat property. The format of the generated private key.

View Source
const (
	ConfigElementDefConfigKeyTypeEcConst  = "ec"
	ConfigElementDefConfigKeyTypeRsaConst = "rsa"
)

Constants associated with the ConfigElementDefConfig.KeyType property. The type of private key to generate.

View Source
const (
	ConfigElementDefConfigSigningMethodExternalConst = "external"
	ConfigElementDefConfigSigningMethodInternalConst = "internal"
)

Constants associated with the ConfigElementDefConfig.SigningMethod property. The signing method to use with this certificate authority to generate private certificates.

You can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).

View Source
const (
	ConfigElementMetadataTypeCertificateTemplateConst              = "certificate_template"
	ConfigElementMetadataTypeCisConst                              = "cis"
	ConfigElementMetadataTypeClassicInfrastructureConst            = "classic_infrastructure"
	ConfigElementMetadataTypeIntermediateCertificateAuthorityConst = "intermediate_certificate_authority"
	ConfigElementMetadataTypeLetsencryptConst                      = "letsencrypt"
	ConfigElementMetadataTypeLetsencryptStageConst                 = "letsencrypt-stage"
	ConfigElementMetadataTypeRootCertificateAuthorityConst         = "root_certificate_authority"
)

Constants associated with the ConfigElementMetadata.Type property. The type of configuration. Value options differ depending on the `config_element` property that you want to define.

View Source
const (
	CreateConfigElementOptionsSecretTypePrivateCertConst = "private_cert"
	CreateConfigElementOptionsSecretTypePublicCertConst  = "public_cert"
)

Constants associated with the CreateConfigElementOptions.SecretType property. The secret type.

View Source
const (
	CreateConfigElementOptionsConfigElementCertificateAuthoritiesConst             = "certificate_authorities"
	CreateConfigElementOptionsConfigElementCertificateTemplatesConst               = "certificate_templates"
	CreateConfigElementOptionsConfigElementDNSProvidersConst                       = "dns_providers"
	CreateConfigElementOptionsConfigElementIntermediateCertificateAuthoritiesConst = "intermediate_certificate_authorities"
	CreateConfigElementOptionsConfigElementRootCertificateAuthoritiesConst         = "root_certificate_authorities"
)

Constants associated with the CreateConfigElementOptions.ConfigElement property. The configuration element to define or manage.

View Source
const (
	CreateConfigElementOptionsTypeCertificateTemplateConst              = "certificate_template"
	CreateConfigElementOptionsTypeCisConst                              = "cis"
	CreateConfigElementOptionsTypeClassicInfrastructureConst            = "classic_infrastructure"
	CreateConfigElementOptionsTypeIntermediateCertificateAuthorityConst = "intermediate_certificate_authority"
	CreateConfigElementOptionsTypeLetsencryptConst                      = "letsencrypt"
	CreateConfigElementOptionsTypeLetsencryptStageConst                 = "letsencrypt-stage"
	CreateConfigElementOptionsTypeRootCertificateAuthorityConst         = "root_certificate_authority"
)

Constants associated with the CreateConfigElementOptions.Type property. The type of configuration. Value options differ depending on the `config_element` property that you want to define.

View Source
const (
	CreateSecretOptionsSecretTypeArbitraryConst        = "arbitrary"
	CreateSecretOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	CreateSecretOptionsSecretTypeImportedCertConst     = "imported_cert"
	CreateSecretOptionsSecretTypeKvConst               = "kv"
	CreateSecretOptionsSecretTypePrivateCertConst      = "private_cert"
	CreateSecretOptionsSecretTypePublicCertConst       = "public_cert"
	CreateSecretOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the CreateSecretOptions.SecretType property. The secret type.

View Source
const (
	DeleteConfigElementOptionsSecretTypePrivateCertConst = "private_cert"
	DeleteConfigElementOptionsSecretTypePublicCertConst  = "public_cert"
)

Constants associated with the DeleteConfigElementOptions.SecretType property. The secret type.

View Source
const (
	DeleteConfigElementOptionsConfigElementCertificateAuthoritiesConst             = "certificate_authorities"
	DeleteConfigElementOptionsConfigElementCertificateTemplatesConst               = "certificate_templates"
	DeleteConfigElementOptionsConfigElementDNSProvidersConst                       = "dns_providers"
	DeleteConfigElementOptionsConfigElementIntermediateCertificateAuthoritiesConst = "intermediate_certificate_authorities"
	DeleteConfigElementOptionsConfigElementRootCertificateAuthoritiesConst         = "root_certificate_authorities"
)

Constants associated with the DeleteConfigElementOptions.ConfigElement property. The configuration element to define or manage.

View Source
const (
	DeleteSecretOptionsSecretTypeArbitraryConst        = "arbitrary"
	DeleteSecretOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	DeleteSecretOptionsSecretTypeImportedCertConst     = "imported_cert"
	DeleteSecretOptionsSecretTypeKvConst               = "kv"
	DeleteSecretOptionsSecretTypePrivateCertConst      = "private_cert"
	DeleteSecretOptionsSecretTypePublicCertConst       = "public_cert"
	DeleteSecretOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the DeleteSecretOptions.SecretType property. The secret type.

View Source
const (
	GetConfigElementOptionsSecretTypePrivateCertConst = "private_cert"
	GetConfigElementOptionsSecretTypePublicCertConst  = "public_cert"
)

Constants associated with the GetConfigElementOptions.SecretType property. The secret type.

View Source
const (
	GetConfigElementOptionsConfigElementCertificateAuthoritiesConst             = "certificate_authorities"
	GetConfigElementOptionsConfigElementCertificateTemplatesConst               = "certificate_templates"
	GetConfigElementOptionsConfigElementDNSProvidersConst                       = "dns_providers"
	GetConfigElementOptionsConfigElementIntermediateCertificateAuthoritiesConst = "intermediate_certificate_authorities"
	GetConfigElementOptionsConfigElementRootCertificateAuthoritiesConst         = "root_certificate_authorities"
)

Constants associated with the GetConfigElementOptions.ConfigElement property. The configuration element to define or manage.

View Source
const (
	GetConfigElementsOptionsSecretTypePrivateCertConst = "private_cert"
	GetConfigElementsOptionsSecretTypePublicCertConst  = "public_cert"
)

Constants associated with the GetConfigElementsOptions.SecretType property. The secret type.

View Source
const (
	GetConfigElementsOptionsConfigElementCertificateAuthoritiesConst             = "certificate_authorities"
	GetConfigElementsOptionsConfigElementCertificateTemplatesConst               = "certificate_templates"
	GetConfigElementsOptionsConfigElementDNSProvidersConst                       = "dns_providers"
	GetConfigElementsOptionsConfigElementIntermediateCertificateAuthoritiesConst = "intermediate_certificate_authorities"
	GetConfigElementsOptionsConfigElementRootCertificateAuthoritiesConst         = "root_certificate_authorities"
)

Constants associated with the GetConfigElementsOptions.ConfigElement property. The configuration element to define or manage.

View Source
const (
	GetConfigOptionsSecretTypeIamCredentialsConst = "iam_credentials"
	GetConfigOptionsSecretTypePrivateCertConst    = "private_cert"
	GetConfigOptionsSecretTypePublicCertConst     = "public_cert"
)

Constants associated with the GetConfigOptions.SecretType property. The secret type.

View Source
const (
	GetLocksOptionsSecretTypeArbitraryConst        = "arbitrary"
	GetLocksOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	GetLocksOptionsSecretTypeImportedCertConst     = "imported_cert"
	GetLocksOptionsSecretTypeKvConst               = "kv"
	GetLocksOptionsSecretTypePrivateCertConst      = "private_cert"
	GetLocksOptionsSecretTypePublicCertConst       = "public_cert"
	GetLocksOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the GetLocksOptions.SecretType property. The secret type.

View Source
const (
	GetPolicyOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	GetPolicyOptionsSecretTypePrivateCertConst      = "private_cert"
	GetPolicyOptionsSecretTypePublicCertConst       = "public_cert"
	GetPolicyOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the GetPolicyOptions.SecretType property. The secret type.

View Source
const (
	GetSecretMetadataOptionsSecretTypeArbitraryConst        = "arbitrary"
	GetSecretMetadataOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	GetSecretMetadataOptionsSecretTypeImportedCertConst     = "imported_cert"
	GetSecretMetadataOptionsSecretTypeKvConst               = "kv"
	GetSecretMetadataOptionsSecretTypePrivateCertConst      = "private_cert"
	GetSecretMetadataOptionsSecretTypePublicCertConst       = "public_cert"
	GetSecretMetadataOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the GetSecretMetadataOptions.SecretType property. The secret type.

View Source
const (
	GetSecretOptionsSecretTypeArbitraryConst        = "arbitrary"
	GetSecretOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	GetSecretOptionsSecretTypeImportedCertConst     = "imported_cert"
	GetSecretOptionsSecretTypeKvConst               = "kv"
	GetSecretOptionsSecretTypePrivateCertConst      = "private_cert"
	GetSecretOptionsSecretTypePublicCertConst       = "public_cert"
	GetSecretOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the GetSecretOptions.SecretType property. The secret type.

View Source
const (
	GetSecretVersionLocksOptionsSecretTypeArbitraryConst        = "arbitrary"
	GetSecretVersionLocksOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	GetSecretVersionLocksOptionsSecretTypeImportedCertConst     = "imported_cert"
	GetSecretVersionLocksOptionsSecretTypeKvConst               = "kv"
	GetSecretVersionLocksOptionsSecretTypePrivateCertConst      = "private_cert"
	GetSecretVersionLocksOptionsSecretTypePublicCertConst       = "public_cert"
	GetSecretVersionLocksOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the GetSecretVersionLocksOptions.SecretType property. The secret type.

View Source
const (
	GetSecretVersionMetadataOptionsSecretTypeArbitraryConst        = "arbitrary"
	GetSecretVersionMetadataOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	GetSecretVersionMetadataOptionsSecretTypeImportedCertConst     = "imported_cert"
	GetSecretVersionMetadataOptionsSecretTypeKvConst               = "kv"
	GetSecretVersionMetadataOptionsSecretTypePrivateCertConst      = "private_cert"
	GetSecretVersionMetadataOptionsSecretTypePublicCertConst       = "public_cert"
	GetSecretVersionMetadataOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the GetSecretVersionMetadataOptions.SecretType property. The secret type.

View Source
const (
	GetSecretVersionOptionsSecretTypeArbitraryConst        = "arbitrary"
	GetSecretVersionOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	GetSecretVersionOptionsSecretTypeImportedCertConst     = "imported_cert"
	GetSecretVersionOptionsSecretTypeKvConst               = "kv"
	GetSecretVersionOptionsSecretTypePrivateCertConst      = "private_cert"
	GetSecretVersionOptionsSecretTypePublicCertConst       = "public_cert"
	GetSecretVersionOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the GetSecretVersionOptions.SecretType property. The secret type.

View Source
const (
	InstanceSecretsLocksSecretTypeArbitraryConst        = "arbitrary"
	InstanceSecretsLocksSecretTypeIamCredentialsConst   = "iam_credentials"
	InstanceSecretsLocksSecretTypeImportedCertConst     = "imported_cert"
	InstanceSecretsLocksSecretTypeKvConst               = "kv"
	InstanceSecretsLocksSecretTypePrivateCertConst      = "private_cert"
	InstanceSecretsLocksSecretTypePublicCertConst       = "public_cert"
	InstanceSecretsLocksSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the InstanceSecretsLocks.SecretType property. The secret type.

View Source
const (
	IntermediateCertificateAuthoritiesConfigItemTypeCertificateTemplateConst              = "certificate_template"
	IntermediateCertificateAuthoritiesConfigItemTypeCisConst                              = "cis"
	IntermediateCertificateAuthoritiesConfigItemTypeClassicInfrastructureConst            = "classic_infrastructure"
	IntermediateCertificateAuthoritiesConfigItemTypeIntermediateCertificateAuthorityConst = "intermediate_certificate_authority"
	IntermediateCertificateAuthoritiesConfigItemTypeLetsencryptConst                      = "letsencrypt"
	IntermediateCertificateAuthoritiesConfigItemTypeLetsencryptStageConst                 = "letsencrypt-stage"
	IntermediateCertificateAuthoritiesConfigItemTypeRootCertificateAuthorityConst         = "root_certificate_authority"
)

Constants associated with the IntermediateCertificateAuthoritiesConfigItem.Type property. The type of configuration. Value options differ depending on the `config_element` property that you want to define.

View Source
const (
	ListAllSecretsOptionsSortByCreationDateConst   = "creation_date"
	ListAllSecretsOptionsSortByExpirationDateConst = "expiration_date"
	ListAllSecretsOptionsSortByIDConst             = "id"
	ListAllSecretsOptionsSortByNameConst           = "name"
	ListAllSecretsOptionsSortBySecretTypeConst     = "secret_type"
)

Constants associated with the ListAllSecretsOptions.SortBy property. Sort a list of secrets by the specified field.

**Usage:** To sort a list of secrets by their creation date, use `../secrets/{secret_type}?sort_by=creation_date`.

View Source
const (
	ListSecretVersionsOptionsSecretTypeArbitraryConst        = "arbitrary"
	ListSecretVersionsOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	ListSecretVersionsOptionsSecretTypeImportedCertConst     = "imported_cert"
	ListSecretVersionsOptionsSecretTypeKvConst               = "kv"
	ListSecretVersionsOptionsSecretTypePrivateCertConst      = "private_cert"
	ListSecretVersionsOptionsSecretTypePublicCertConst       = "public_cert"
	ListSecretVersionsOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the ListSecretVersionsOptions.SecretType property. The secret type.

View Source
const (
	ListSecretsOptionsSecretTypeArbitraryConst        = "arbitrary"
	ListSecretsOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	ListSecretsOptionsSecretTypeImportedCertConst     = "imported_cert"
	ListSecretsOptionsSecretTypeKvConst               = "kv"
	ListSecretsOptionsSecretTypePrivateCertConst      = "private_cert"
	ListSecretsOptionsSecretTypePublicCertConst       = "public_cert"
	ListSecretsOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the ListSecretsOptions.SecretType property. The secret type.

View Source
const (
	LockSecretOptionsSecretTypeArbitraryConst        = "arbitrary"
	LockSecretOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	LockSecretOptionsSecretTypeImportedCertConst     = "imported_cert"
	LockSecretOptionsSecretTypeKvConst               = "kv"
	LockSecretOptionsSecretTypePrivateCertConst      = "private_cert"
	LockSecretOptionsSecretTypePublicCertConst       = "public_cert"
	LockSecretOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the LockSecretOptions.SecretType property. The secret type.

View Source
const (
	LockSecretOptionsModeExclusiveConst       = "exclusive"
	LockSecretOptionsModeExclusiveDeleteConst = "exclusive_delete"
)

Constants associated with the LockSecretOptions.Mode property. An optional lock mode. At lock creation, you can set one of the following modes to clear any matching locks on a secret version. Note: When you are locking the `previous` version, the mode parameter is ignored.

- `exclusive`: Removes any other locks with matching names if they are found in the previous version of the secret. - `exclusive_delete`: Same as `exclusive`, but also permanently deletes the data of the previous secret version if it doesn't have any locks.

View Source
const (
	LockSecretVersionOptionsSecretTypeArbitraryConst        = "arbitrary"
	LockSecretVersionOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	LockSecretVersionOptionsSecretTypeImportedCertConst     = "imported_cert"
	LockSecretVersionOptionsSecretTypeKvConst               = "kv"
	LockSecretVersionOptionsSecretTypePrivateCertConst      = "private_cert"
	LockSecretVersionOptionsSecretTypePublicCertConst       = "public_cert"
	LockSecretVersionOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the LockSecretVersionOptions.SecretType property. The secret type.

View Source
const (
	LockSecretVersionOptionsModeExclusiveConst       = "exclusive"
	LockSecretVersionOptionsModeExclusiveDeleteConst = "exclusive_delete"
)

Constants associated with the LockSecretVersionOptions.Mode property. An optional lock mode. At lock creation, you can set one of the following modes to clear any matching locks on a secret version. Note: When you are locking the `previous` version, the mode parameter is ignored.

- `exclusive`: Removes any other locks with matching names if they are found in the previous version of the secret. - `exclusive_delete`: Same as `exclusive`, but also permanently deletes the data of the previous secret version if it doesn't have any locks.

View Source
const (
	PutPolicyOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	PutPolicyOptionsSecretTypePrivateCertConst      = "private_cert"
	PutPolicyOptionsSecretTypePublicCertConst       = "public_cert"
	PutPolicyOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the PutPolicyOptions.SecretType property. The secret type.

View Source
const (
	RootCertificateAuthoritiesConfigItemTypeCertificateTemplateConst              = "certificate_template"
	RootCertificateAuthoritiesConfigItemTypeCisConst                              = "cis"
	RootCertificateAuthoritiesConfigItemTypeClassicInfrastructureConst            = "classic_infrastructure"
	RootCertificateAuthoritiesConfigItemTypeIntermediateCertificateAuthorityConst = "intermediate_certificate_authority"
	RootCertificateAuthoritiesConfigItemTypeLetsencryptConst                      = "letsencrypt"
	RootCertificateAuthoritiesConfigItemTypeLetsencryptStageConst                 = "letsencrypt-stage"
	RootCertificateAuthoritiesConfigItemTypeRootCertificateAuthorityConst         = "root_certificate_authority"
)

Constants associated with the RootCertificateAuthoritiesConfigItem.Type property. The type of configuration. Value options differ depending on the `config_element` property that you want to define.

View Source
const (
	RotationUnitDayConst   = "day"
	RotationUnitMonthConst = "month"
)

Constants associated with the Rotation.Unit property. The time unit of the rotation interval.

**Note:** Use this field only for private certificates. It is ignored for public certificates.

View Source
const (
	SecretLockVersionAliasCurrentConst  = "current"
	SecretLockVersionAliasPreviousConst = "previous"
)

Constants associated with the SecretLockVersion.Alias property. A human-readable alias that describes the secret version. 'Current' is used for version `n` and 'previous' is used for version `n-1`.

View Source
const (
	SecretMetadataSecretTypeArbitraryConst        = "arbitrary"
	SecretMetadataSecretTypeIamCredentialsConst   = "iam_credentials"
	SecretMetadataSecretTypeImportedCertConst     = "imported_cert"
	SecretMetadataSecretTypeKvConst               = "kv"
	SecretMetadataSecretTypePrivateCertConst      = "private_cert"
	SecretMetadataSecretTypePublicCertConst       = "public_cert"
	SecretMetadataSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the SecretMetadata.SecretType property. The secret type.

View Source
const (
	SecretPolicyRotationRotationUnitDayConst   = "day"
	SecretPolicyRotationRotationUnitMonthConst = "month"
)

Constants associated with the SecretPolicyRotationRotation.Unit property. The units for the secret rotation time interval.

View Source
const (
	SecretResourceSecretTypeArbitraryConst        = "arbitrary"
	SecretResourceSecretTypeIamCredentialsConst   = "iam_credentials"
	SecretResourceSecretTypeImportedCertConst     = "imported_cert"
	SecretResourceSecretTypeKvConst               = "kv"
	SecretResourceSecretTypePrivateCertConst      = "private_cert"
	SecretResourceSecretTypePublicCertConst       = "public_cert"
	SecretResourceSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the SecretResource.SecretType property. The secret type.

View Source
const (
	SecretResourceFormatPemConst       = "pem"
	SecretResourceFormatPemBundleConst = "pem_bundle"
)

Constants associated with the SecretResource.Format property. The format of the returned data.

View Source
const (
	SecretResourcePrivateKeyFormatDerConst   = "der"
	SecretResourcePrivateKeyFormatPkcs8Const = "pkcs8"
)

Constants associated with the SecretResource.PrivateKeyFormat property. The format of the generated private key.

View Source
const (
	UnlockSecretOptionsSecretTypeArbitraryConst        = "arbitrary"
	UnlockSecretOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	UnlockSecretOptionsSecretTypeImportedCertConst     = "imported_cert"
	UnlockSecretOptionsSecretTypeKvConst               = "kv"
	UnlockSecretOptionsSecretTypePrivateCertConst      = "private_cert"
	UnlockSecretOptionsSecretTypePublicCertConst       = "public_cert"
	UnlockSecretOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the UnlockSecretOptions.SecretType property. The secret type.

View Source
const (
	UnlockSecretVersionOptionsSecretTypeArbitraryConst        = "arbitrary"
	UnlockSecretVersionOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	UnlockSecretVersionOptionsSecretTypeImportedCertConst     = "imported_cert"
	UnlockSecretVersionOptionsSecretTypeKvConst               = "kv"
	UnlockSecretVersionOptionsSecretTypePrivateCertConst      = "private_cert"
	UnlockSecretVersionOptionsSecretTypePublicCertConst       = "public_cert"
	UnlockSecretVersionOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the UnlockSecretVersionOptions.SecretType property. The secret type.

View Source
const (
	UpdateConfigElementOptionsSecretTypePrivateCertConst = "private_cert"
	UpdateConfigElementOptionsSecretTypePublicCertConst  = "public_cert"
)

Constants associated with the UpdateConfigElementOptions.SecretType property. The secret type.

View Source
const (
	UpdateConfigElementOptionsConfigElementCertificateAuthoritiesConst             = "certificate_authorities"
	UpdateConfigElementOptionsConfigElementCertificateTemplatesConst               = "certificate_templates"
	UpdateConfigElementOptionsConfigElementDNSProvidersConst                       = "dns_providers"
	UpdateConfigElementOptionsConfigElementIntermediateCertificateAuthoritiesConst = "intermediate_certificate_authorities"
	UpdateConfigElementOptionsConfigElementRootCertificateAuthoritiesConst         = "root_certificate_authorities"
)

Constants associated with the UpdateConfigElementOptions.ConfigElement property. The configuration element to define or manage.

View Source
const (
	UpdateConfigElementOptionsTypeCertificateTemplateConst              = "certificate_template"
	UpdateConfigElementOptionsTypeCisConst                              = "cis"
	UpdateConfigElementOptionsTypeClassicInfrastructureConst            = "classic_infrastructure"
	UpdateConfigElementOptionsTypeIntermediateCertificateAuthorityConst = "intermediate_certificate_authority"
	UpdateConfigElementOptionsTypeLetsencryptConst                      = "letsencrypt"
	UpdateConfigElementOptionsTypeLetsencryptStageConst                 = "letsencrypt-stage"
	UpdateConfigElementOptionsTypeRootCertificateAuthorityConst         = "root_certificate_authority"
)

Constants associated with the UpdateConfigElementOptions.Type property. The type of configuration. Value options differ depending on the `config_element` property that you want to define.

View Source
const (
	UpdateSecretMetadataOptionsSecretTypeArbitraryConst        = "arbitrary"
	UpdateSecretMetadataOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	UpdateSecretMetadataOptionsSecretTypeImportedCertConst     = "imported_cert"
	UpdateSecretMetadataOptionsSecretTypeKvConst               = "kv"
	UpdateSecretMetadataOptionsSecretTypePrivateCertConst      = "private_cert"
	UpdateSecretMetadataOptionsSecretTypePublicCertConst       = "public_cert"
	UpdateSecretMetadataOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the UpdateSecretMetadataOptions.SecretType property. The secret type.

View Source
const (
	UpdateSecretOptionsSecretTypeArbitraryConst        = "arbitrary"
	UpdateSecretOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	UpdateSecretOptionsSecretTypeImportedCertConst     = "imported_cert"
	UpdateSecretOptionsSecretTypeKvConst               = "kv"
	UpdateSecretOptionsSecretTypePrivateCertConst      = "private_cert"
	UpdateSecretOptionsSecretTypePublicCertConst       = "public_cert"
	UpdateSecretOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the UpdateSecretOptions.SecretType property. The secret type.

View Source
const (
	UpdateSecretOptionsActionDeleteCredentialsConst    = "delete_credentials"
	UpdateSecretOptionsActionRestoreConst              = "restore"
	UpdateSecretOptionsActionRevokeConst               = "revoke"
	UpdateSecretOptionsActionRotateConst               = "rotate"
	UpdateSecretOptionsActionValidateDNSChallengeConst = "validate_dns_challenge"
)

Constants associated with the UpdateSecretOptions.Action property. The action to perform on the specified secret.

View Source
const (
	UpdateSecretVersionMetadataOptionsSecretTypeArbitraryConst        = "arbitrary"
	UpdateSecretVersionMetadataOptionsSecretTypeIamCredentialsConst   = "iam_credentials"
	UpdateSecretVersionMetadataOptionsSecretTypeImportedCertConst     = "imported_cert"
	UpdateSecretVersionMetadataOptionsSecretTypeKvConst               = "kv"
	UpdateSecretVersionMetadataOptionsSecretTypePrivateCertConst      = "private_cert"
	UpdateSecretVersionMetadataOptionsSecretTypePublicCertConst       = "public_cert"
	UpdateSecretVersionMetadataOptionsSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the UpdateSecretVersionMetadataOptions.SecretType property. The secret type.

View Source
const (
	ArbitrarySecretMetadataSecretTypeArbitraryConst        = "arbitrary"
	ArbitrarySecretMetadataSecretTypeIamCredentialsConst   = "iam_credentials"
	ArbitrarySecretMetadataSecretTypeImportedCertConst     = "imported_cert"
	ArbitrarySecretMetadataSecretTypeKvConst               = "kv"
	ArbitrarySecretMetadataSecretTypePrivateCertConst      = "private_cert"
	ArbitrarySecretMetadataSecretTypePublicCertConst       = "public_cert"
	ArbitrarySecretMetadataSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the ArbitrarySecretMetadata.SecretType property. The secret type.

View Source
const (
	ArbitrarySecretResourceSecretTypeArbitraryConst        = "arbitrary"
	ArbitrarySecretResourceSecretTypeIamCredentialsConst   = "iam_credentials"
	ArbitrarySecretResourceSecretTypeImportedCertConst     = "imported_cert"
	ArbitrarySecretResourceSecretTypeKvConst               = "kv"
	ArbitrarySecretResourceSecretTypePrivateCertConst      = "private_cert"
	ArbitrarySecretResourceSecretTypePublicCertConst       = "public_cert"
	ArbitrarySecretResourceSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the ArbitrarySecretResource.SecretType property. The secret type.

View Source
const (
	CertificateSecretMetadataSecretTypeArbitraryConst        = "arbitrary"
	CertificateSecretMetadataSecretTypeIamCredentialsConst   = "iam_credentials"
	CertificateSecretMetadataSecretTypeImportedCertConst     = "imported_cert"
	CertificateSecretMetadataSecretTypeKvConst               = "kv"
	CertificateSecretMetadataSecretTypePrivateCertConst      = "private_cert"
	CertificateSecretMetadataSecretTypePublicCertConst       = "public_cert"
	CertificateSecretMetadataSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the CertificateSecretMetadata.SecretType property. The secret type.

View Source
const (
	CertificateSecretResourceSecretTypeArbitraryConst        = "arbitrary"
	CertificateSecretResourceSecretTypeIamCredentialsConst   = "iam_credentials"
	CertificateSecretResourceSecretTypeImportedCertConst     = "imported_cert"
	CertificateSecretResourceSecretTypeKvConst               = "kv"
	CertificateSecretResourceSecretTypePrivateCertConst      = "private_cert"
	CertificateSecretResourceSecretTypePublicCertConst       = "public_cert"
	CertificateSecretResourceSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the CertificateSecretResource.SecretType property. The secret type.

View Source
const (
	CertificateTemplateConfigKeyTypeEcConst  = "ec"
	CertificateTemplateConfigKeyTypeRsaConst = "rsa"
)

Constants associated with the CertificateTemplateConfig.KeyType property. The type of private key to generate for private certificates and the type of key that is expected for submitted certificate signing requests (CSRs).

Allowable values are: `rsa` and `ec`.

View Source
const (
	IamCredentialsSecretMetadataSecretTypeArbitraryConst        = "arbitrary"
	IamCredentialsSecretMetadataSecretTypeIamCredentialsConst   = "iam_credentials"
	IamCredentialsSecretMetadataSecretTypeImportedCertConst     = "imported_cert"
	IamCredentialsSecretMetadataSecretTypeKvConst               = "kv"
	IamCredentialsSecretMetadataSecretTypePrivateCertConst      = "private_cert"
	IamCredentialsSecretMetadataSecretTypePublicCertConst       = "public_cert"
	IamCredentialsSecretMetadataSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the IamCredentialsSecretMetadata.SecretType property. The secret type.

View Source
const (
	IamCredentialsSecretResourceSecretTypeArbitraryConst        = "arbitrary"
	IamCredentialsSecretResourceSecretTypeIamCredentialsConst   = "iam_credentials"
	IamCredentialsSecretResourceSecretTypeImportedCertConst     = "imported_cert"
	IamCredentialsSecretResourceSecretTypeKvConst               = "kv"
	IamCredentialsSecretResourceSecretTypePrivateCertConst      = "private_cert"
	IamCredentialsSecretResourceSecretTypePublicCertConst       = "public_cert"
	IamCredentialsSecretResourceSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the IamCredentialsSecretResource.SecretType property. The secret type.

View Source
const (
	IntermediateCertificateAuthorityConfigSigningMethodExternalConst = "external"
	IntermediateCertificateAuthorityConfigSigningMethodInternalConst = "internal"
)

Constants associated with the IntermediateCertificateAuthorityConfig.SigningMethod property. The signing method to use with this certificate authority to generate private certificates.

You can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).

View Source
const (
	IntermediateCertificateAuthorityConfigStatusCertificateTemplateRequiredConst = "certificate_template_required"
	IntermediateCertificateAuthorityConfigStatusConfiguredConst                  = "configured"
	IntermediateCertificateAuthorityConfigStatusExpiredConst                     = "expired"
	IntermediateCertificateAuthorityConfigStatusRevokedConst                     = "revoked"
	IntermediateCertificateAuthorityConfigStatusSignedCertificateRequiredConst   = "signed_certificate_required"
	IntermediateCertificateAuthorityConfigStatusSigningRequiredConst             = "signing_required"
)

Constants associated with the IntermediateCertificateAuthorityConfig.Status property. The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`, `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.

View Source
const (
	IntermediateCertificateAuthorityConfigFormatPemConst       = "pem"
	IntermediateCertificateAuthorityConfigFormatPemBundleConst = "pem_bundle"
)

Constants associated with the IntermediateCertificateAuthorityConfig.Format property. The format of the returned data.

View Source
const (
	IntermediateCertificateAuthorityConfigPrivateKeyFormatDerConst   = "der"
	IntermediateCertificateAuthorityConfigPrivateKeyFormatPkcs8Const = "pkcs8"
)

Constants associated with the IntermediateCertificateAuthorityConfig.PrivateKeyFormat property. The format of the generated private key.

View Source
const (
	IntermediateCertificateAuthorityConfigKeyTypeEcConst  = "ec"
	IntermediateCertificateAuthorityConfigKeyTypeRsaConst = "rsa"
)

Constants associated with the IntermediateCertificateAuthorityConfig.KeyType property. The type of private key to generate.

View Source
const (
	KvSecretMetadataSecretTypeArbitraryConst        = "arbitrary"
	KvSecretMetadataSecretTypeIamCredentialsConst   = "iam_credentials"
	KvSecretMetadataSecretTypeImportedCertConst     = "imported_cert"
	KvSecretMetadataSecretTypeKvConst               = "kv"
	KvSecretMetadataSecretTypePrivateCertConst      = "private_cert"
	KvSecretMetadataSecretTypePublicCertConst       = "public_cert"
	KvSecretMetadataSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the KvSecretMetadata.SecretType property. The secret type.

View Source
const (
	KvSecretResourceSecretTypeArbitraryConst        = "arbitrary"
	KvSecretResourceSecretTypeIamCredentialsConst   = "iam_credentials"
	KvSecretResourceSecretTypeImportedCertConst     = "imported_cert"
	KvSecretResourceSecretTypeKvConst               = "kv"
	KvSecretResourceSecretTypePrivateCertConst      = "private_cert"
	KvSecretResourceSecretTypePublicCertConst       = "public_cert"
	KvSecretResourceSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the KvSecretResource.SecretType property. The secret type.

View Source
const (
	PrivateCertPolicyRotationUnitDayConst   = "day"
	PrivateCertPolicyRotationUnitMonthConst = "month"
)

Constants associated with the PrivateCertPolicyRotation.Unit property. The units for the secret rotation time interval.

View Source
const (
	PrivateCertificateSecretMetadataSecretTypeArbitraryConst        = "arbitrary"
	PrivateCertificateSecretMetadataSecretTypeIamCredentialsConst   = "iam_credentials"
	PrivateCertificateSecretMetadataSecretTypeImportedCertConst     = "imported_cert"
	PrivateCertificateSecretMetadataSecretTypeKvConst               = "kv"
	PrivateCertificateSecretMetadataSecretTypePrivateCertConst      = "private_cert"
	PrivateCertificateSecretMetadataSecretTypePublicCertConst       = "public_cert"
	PrivateCertificateSecretMetadataSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the PrivateCertificateSecretMetadata.SecretType property. The secret type.

View Source
const (
	PrivateCertificateSecretResourceSecretTypeArbitraryConst        = "arbitrary"
	PrivateCertificateSecretResourceSecretTypeIamCredentialsConst   = "iam_credentials"
	PrivateCertificateSecretResourceSecretTypeImportedCertConst     = "imported_cert"
	PrivateCertificateSecretResourceSecretTypeKvConst               = "kv"
	PrivateCertificateSecretResourceSecretTypePrivateCertConst      = "private_cert"
	PrivateCertificateSecretResourceSecretTypePublicCertConst       = "public_cert"
	PrivateCertificateSecretResourceSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the PrivateCertificateSecretResource.SecretType property. The secret type.

View Source
const (
	PrivateCertificateSecretResourceFormatPemConst       = "pem"
	PrivateCertificateSecretResourceFormatPemBundleConst = "pem_bundle"
)

Constants associated with the PrivateCertificateSecretResource.Format property. The format of the returned data.

View Source
const (
	PrivateCertificateSecretResourcePrivateKeyFormatDerConst   = "der"
	PrivateCertificateSecretResourcePrivateKeyFormatPkcs8Const = "pkcs8"
)

Constants associated with the PrivateCertificateSecretResource.PrivateKeyFormat property. The format of the generated private key.

View Source
const (
	PublicCertificateSecretMetadataSecretTypeArbitraryConst        = "arbitrary"
	PublicCertificateSecretMetadataSecretTypeIamCredentialsConst   = "iam_credentials"
	PublicCertificateSecretMetadataSecretTypeImportedCertConst     = "imported_cert"
	PublicCertificateSecretMetadataSecretTypeKvConst               = "kv"
	PublicCertificateSecretMetadataSecretTypePrivateCertConst      = "private_cert"
	PublicCertificateSecretMetadataSecretTypePublicCertConst       = "public_cert"
	PublicCertificateSecretMetadataSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the PublicCertificateSecretMetadata.SecretType property. The secret type.

View Source
const (
	PublicCertificateSecretMetadataKeyAlgorithmEc256Const   = "EC256"
	PublicCertificateSecretMetadataKeyAlgorithmEc384Const   = "EC384"
	PublicCertificateSecretMetadataKeyAlgorithmRsa2048Const = "RSA2048"
	PublicCertificateSecretMetadataKeyAlgorithmRsa4096Const = "RSA4096"
)

Constants associated with the PublicCertificateSecretMetadata.KeyAlgorithm property. The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.

View Source
const (
	PublicCertificateSecretResourceSecretTypeArbitraryConst        = "arbitrary"
	PublicCertificateSecretResourceSecretTypeIamCredentialsConst   = "iam_credentials"
	PublicCertificateSecretResourceSecretTypeImportedCertConst     = "imported_cert"
	PublicCertificateSecretResourceSecretTypeKvConst               = "kv"
	PublicCertificateSecretResourceSecretTypePrivateCertConst      = "private_cert"
	PublicCertificateSecretResourceSecretTypePublicCertConst       = "public_cert"
	PublicCertificateSecretResourceSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the PublicCertificateSecretResource.SecretType property. The secret type.

View Source
const (
	PublicCertificateSecretResourceKeyAlgorithmEc256Const   = "EC256"
	PublicCertificateSecretResourceKeyAlgorithmEc384Const   = "EC384"
	PublicCertificateSecretResourceKeyAlgorithmRsa2048Const = "RSA2048"
	PublicCertificateSecretResourceKeyAlgorithmRsa4096Const = "RSA4096"
)

Constants associated with the PublicCertificateSecretResource.KeyAlgorithm property. The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.

The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection.

View Source
const (
	RootCertificateAuthorityConfigStatusCertificateTemplateRequiredConst = "certificate_template_required"
	RootCertificateAuthorityConfigStatusConfiguredConst                  = "configured"
	RootCertificateAuthorityConfigStatusExpiredConst                     = "expired"
	RootCertificateAuthorityConfigStatusRevokedConst                     = "revoked"
	RootCertificateAuthorityConfigStatusSignedCertificateRequiredConst   = "signed_certificate_required"
	RootCertificateAuthorityConfigStatusSigningRequiredConst             = "signing_required"
)

Constants associated with the RootCertificateAuthorityConfig.Status property. The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`, `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.

View Source
const (
	RootCertificateAuthorityConfigFormatPemConst       = "pem"
	RootCertificateAuthorityConfigFormatPemBundleConst = "pem_bundle"
)

Constants associated with the RootCertificateAuthorityConfig.Format property. The format of the returned data.

View Source
const (
	RootCertificateAuthorityConfigPrivateKeyFormatDerConst   = "der"
	RootCertificateAuthorityConfigPrivateKeyFormatPkcs8Const = "pkcs8"
)

Constants associated with the RootCertificateAuthorityConfig.PrivateKeyFormat property. The format of the generated private key.

View Source
const (
	RootCertificateAuthorityConfigKeyTypeEcConst  = "ec"
	RootCertificateAuthorityConfigKeyTypeRsaConst = "rsa"
)

Constants associated with the RootCertificateAuthorityConfig.KeyType property. The type of private key to generate.

View Source
const (
	SecretPolicyRotationRotationPolicyRotationUnitDayConst   = "day"
	SecretPolicyRotationRotationPolicyRotationUnitMonthConst = "month"
)

Constants associated with the SecretPolicyRotationRotationPolicyRotation.Unit property. The units for the secret rotation time interval.

View Source
const (
	SignCsrActionFormatPemConst       = "pem"
	SignCsrActionFormatPemBundleConst = "pem_bundle"
)

Constants associated with the SignCsrAction.Format property. The format of the returned data.

View Source
const (
	SignCsrActionResultFormatPemConst       = "pem"
	SignCsrActionResultFormatPemBundleConst = "pem_bundle"
)

Constants associated with the SignCsrActionResult.Format property. The format of the returned data.

View Source
const (
	SignIntermediateActionFormatPemConst       = "pem"
	SignIntermediateActionFormatPemBundleConst = "pem_bundle"
)

Constants associated with the SignIntermediateAction.Format property. The format of the returned data.

View Source
const (
	SignIntermediateActionResultFormatPemConst       = "pem"
	SignIntermediateActionResultFormatPemBundleConst = "pem_bundle"
)

Constants associated with the SignIntermediateActionResult.Format property. The format of the returned data.

View Source
const (
	UsernamePasswordSecretMetadataSecretTypeArbitraryConst        = "arbitrary"
	UsernamePasswordSecretMetadataSecretTypeIamCredentialsConst   = "iam_credentials"
	UsernamePasswordSecretMetadataSecretTypeImportedCertConst     = "imported_cert"
	UsernamePasswordSecretMetadataSecretTypeKvConst               = "kv"
	UsernamePasswordSecretMetadataSecretTypePrivateCertConst      = "private_cert"
	UsernamePasswordSecretMetadataSecretTypePublicCertConst       = "public_cert"
	UsernamePasswordSecretMetadataSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the UsernamePasswordSecretMetadata.SecretType property. The secret type.

View Source
const (
	UsernamePasswordSecretResourceSecretTypeArbitraryConst        = "arbitrary"
	UsernamePasswordSecretResourceSecretTypeIamCredentialsConst   = "iam_credentials"
	UsernamePasswordSecretResourceSecretTypeImportedCertConst     = "imported_cert"
	UsernamePasswordSecretResourceSecretTypeKvConst               = "kv"
	UsernamePasswordSecretResourceSecretTypePrivateCertConst      = "private_cert"
	UsernamePasswordSecretResourceSecretTypePublicCertConst       = "public_cert"
	UsernamePasswordSecretResourceSecretTypeUsernamePasswordConst = "username_password"
)

Constants associated with the UsernamePasswordSecretResource.SecretType property. The secret type.

View Source
const (
	ActionOnConfigElementOptionsSecretTypePrivateCertConst = "private_cert"
)

Constants associated with the ActionOnConfigElementOptions.SecretType property. The secret type.

View Source
const DefaultServiceName = "secrets_manager"

DefaultServiceName is the default key used to find external configuration information.

View Source
const (
	GetPolicyOptionsPolicyRotationConst = "rotation"
)

Constants associated with the GetPolicyOptions.Policy property. The type of policy that is associated with the specified secret.

View Source
const (
	PutConfigOptionsSecretTypeIamCredentialsConst = "iam_credentials"
)

Constants associated with the PutConfigOptions.SecretType property. The secret type.

View Source
const (
	PutPolicyOptionsPolicyRotationConst = "rotation"
)

Constants associated with the PutPolicyOptions.Policy property. The type of policy that is associated with the specified secret.

View Source
const (
	SecretPolicyRotationTypeApplicationVndIBMSecretsManagerSecretPolicyJSONConst = "application/vnd.ibm.secrets-manager.secret.policy+json"
)

Constants associated with the SecretPolicyRotation.Type property. The MIME type that represents the policy. Currently, only the default is supported.

View Source
const (
	UpdateSecretVersionOptionsActionRevokeConst = "revoke"
)

Constants associated with the UpdateSecretVersionOptions.Action property. The action to perform on the specified secret version.

View Source
const (
	UpdateSecretVersionOptionsSecretTypePrivateCertConst = "private_cert"
)

Constants associated with the UpdateSecretVersionOptions.SecretType property. The secret type.

Variables

This section is empty.

Functions

func GetServiceURLForRegion

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalArbitrarySecretMetadata added in v1.0.22

func UnmarshalArbitrarySecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalArbitrarySecretMetadata unmarshals an instance of ArbitrarySecretMetadata from the specified map of raw messages.

func UnmarshalArbitrarySecretResource added in v1.0.22

func UnmarshalArbitrarySecretResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalArbitrarySecretResource unmarshals an instance of ArbitrarySecretResource from the specified map of raw messages.

func UnmarshalArbitrarySecretVersion added in v1.0.28

func UnmarshalArbitrarySecretVersion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalArbitrarySecretVersion unmarshals an instance of ArbitrarySecretVersion from the specified map of raw messages.

func UnmarshalArbitrarySecretVersionInfo added in v1.0.28

func UnmarshalArbitrarySecretVersionInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalArbitrarySecretVersionInfo unmarshals an instance of ArbitrarySecretVersionInfo from the specified map of raw messages.

func UnmarshalArbitrarySecretVersionMetadata added in v1.0.22

func UnmarshalArbitrarySecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalArbitrarySecretVersionMetadata unmarshals an instance of ArbitrarySecretVersionMetadata from the specified map of raw messages.

func UnmarshalCertificateSecretData added in v1.0.22

func UnmarshalCertificateSecretData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateSecretData unmarshals an instance of CertificateSecretData from the specified map of raw messages.

func UnmarshalCertificateSecretMetadata added in v1.0.22

func UnmarshalCertificateSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateSecretMetadata unmarshals an instance of CertificateSecretMetadata from the specified map of raw messages.

func UnmarshalCertificateSecretResource added in v1.0.22

func UnmarshalCertificateSecretResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateSecretResource unmarshals an instance of CertificateSecretResource from the specified map of raw messages.

func UnmarshalCertificateSecretVersion added in v1.0.22

func UnmarshalCertificateSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateSecretVersion unmarshals an instance of CertificateSecretVersion from the specified map of raw messages.

func UnmarshalCertificateSecretVersionInfo added in v1.0.28

func UnmarshalCertificateSecretVersionInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateSecretVersionInfo unmarshals an instance of CertificateSecretVersionInfo from the specified map of raw messages.

func UnmarshalCertificateSecretVersionMetadata added in v1.0.22

func UnmarshalCertificateSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateSecretVersionMetadata unmarshals an instance of CertificateSecretVersionMetadata from the specified map of raw messages.

func UnmarshalCertificateTemplateConfig added in v1.0.39

func UnmarshalCertificateTemplateConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateTemplateConfig unmarshals an instance of CertificateTemplateConfig from the specified map of raw messages.

func UnmarshalCertificateTemplatesConfig added in v1.0.42

func UnmarshalCertificateTemplatesConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateTemplatesConfig unmarshals an instance of CertificateTemplatesConfig from the specified map of raw messages.

func UnmarshalCertificateTemplatesConfigItem added in v1.0.42

func UnmarshalCertificateTemplatesConfigItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateTemplatesConfigItem unmarshals an instance of CertificateTemplatesConfigItem from the specified map of raw messages.

func UnmarshalCertificateValidity added in v1.0.22

func UnmarshalCertificateValidity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificateValidity unmarshals an instance of CertificateValidity from the specified map of raw messages.

func UnmarshalChallengeResource added in v1.0.47

func UnmarshalChallengeResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChallengeResource unmarshals an instance of ChallengeResource from the specified map of raw messages.

func UnmarshalCollectionMetadata

func UnmarshalCollectionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCollectionMetadata unmarshals an instance of CollectionMetadata from the specified map of raw messages.

func UnmarshalConfigAction added in v1.0.39

func UnmarshalConfigAction(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigAction unmarshals an instance of ConfigAction from the specified map of raw messages.

func UnmarshalConfigElementActionData added in v1.0.39

func UnmarshalConfigElementActionData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementActionData unmarshals an instance of ConfigElementActionData from the specified map of raw messages.

func UnmarshalConfigElementActionResult added in v1.0.39

func UnmarshalConfigElementActionResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementActionResult unmarshals an instance of ConfigElementActionResult from the specified map of raw messages.

func UnmarshalConfigElementActionResultConfig added in v1.0.39

func UnmarshalConfigElementActionResultConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementActionResultConfig unmarshals an instance of ConfigElementActionResultConfig from the specified map of raw messages.

func UnmarshalConfigElementDef added in v1.0.25

func UnmarshalConfigElementDef(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementDef unmarshals an instance of ConfigElementDef from the specified map of raw messages.

func UnmarshalConfigElementDefConfig added in v1.0.25

func UnmarshalConfigElementDefConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementDefConfig unmarshals an instance of ConfigElementDefConfig from the specified map of raw messages.

func UnmarshalConfigElementDefConfigClassicInfrastructureConfig added in v1.0.25

func UnmarshalConfigElementDefConfigClassicInfrastructureConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementDefConfigClassicInfrastructureConfig unmarshals an instance of ConfigElementDefConfigClassicInfrastructureConfig from the specified map of raw messages.

func UnmarshalConfigElementDefConfigCloudInternetServicesConfig added in v1.0.25

func UnmarshalConfigElementDefConfigCloudInternetServicesConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementDefConfigCloudInternetServicesConfig unmarshals an instance of ConfigElementDefConfigCloudInternetServicesConfig from the specified map of raw messages.

func UnmarshalConfigElementDefConfigLetsEncryptConfig added in v1.0.25

func UnmarshalConfigElementDefConfigLetsEncryptConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementDefConfigLetsEncryptConfig unmarshals an instance of ConfigElementDefConfigLetsEncryptConfig from the specified map of raw messages.

func UnmarshalConfigElementMetadata added in v1.0.25

func UnmarshalConfigElementMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigElementMetadata unmarshals an instance of ConfigElementMetadata from the specified map of raw messages.

func UnmarshalCreateIamCredentialsSecretEngineRootConfig added in v1.0.27

func UnmarshalCreateIamCredentialsSecretEngineRootConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateIamCredentialsSecretEngineRootConfig unmarshals an instance of CreateIamCredentialsSecretEngineRootConfig from the specified map of raw messages.

func UnmarshalCreateSecret

func UnmarshalCreateSecret(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateSecret unmarshals an instance of CreateSecret from the specified map of raw messages.

func UnmarshalDeleteCredentialsForIamCredentialsSecret added in v1.0.22

func UnmarshalDeleteCredentialsForIamCredentialsSecret(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteCredentialsForIamCredentialsSecret unmarshals an instance of DeleteCredentialsForIamCredentialsSecret from the specified map of raw messages.

func UnmarshalEngineConfig added in v1.0.22

func UnmarshalEngineConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEngineConfig unmarshals an instance of EngineConfig from the specified map of raw messages.

func UnmarshalGetConfig added in v0.1.20

func UnmarshalGetConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetConfig unmarshals an instance of GetConfig from the specified map of raw messages.

func UnmarshalGetConfigElements added in v1.0.25

func UnmarshalGetConfigElements(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetConfigElements unmarshals an instance of GetConfigElements from the specified map of raw messages.

func UnmarshalGetConfigElementsResourcesItem added in v1.0.25

func UnmarshalGetConfigElementsResourcesItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetConfigElementsResourcesItem unmarshals an instance of GetConfigElementsResourcesItem from the specified map of raw messages.

func UnmarshalGetConfigElementsResourcesItemCertificateAuthoritiesConfig added in v1.0.25

func UnmarshalGetConfigElementsResourcesItemCertificateAuthoritiesConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetConfigElementsResourcesItemCertificateAuthoritiesConfig unmarshals an instance of GetConfigElementsResourcesItemCertificateAuthoritiesConfig from the specified map of raw messages.

func UnmarshalGetConfigElementsResourcesItemDNSProvidersConfig added in v1.0.25

func UnmarshalGetConfigElementsResourcesItemDNSProvidersConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetConfigElementsResourcesItemDNSProvidersConfig unmarshals an instance of GetConfigElementsResourcesItemDNSProvidersConfig from the specified map of raw messages.

func UnmarshalGetConfigResourcesItem added in v1.0.25

func UnmarshalGetConfigResourcesItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetConfigResourcesItem unmarshals an instance of GetConfigResourcesItem from the specified map of raw messages.

func UnmarshalGetInstanceLocks added in v1.0.45

func UnmarshalGetInstanceLocks(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetInstanceLocks unmarshals an instance of GetInstanceLocks from the specified map of raw messages.

func UnmarshalGetNotificationsSettings added in v1.0.28

func UnmarshalGetNotificationsSettings(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetNotificationsSettings unmarshals an instance of GetNotificationsSettings from the specified map of raw messages.

func UnmarshalGetSecret

func UnmarshalGetSecret(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetSecret unmarshals an instance of GetSecret from the specified map of raw messages.

func UnmarshalGetSecretLocks added in v1.0.45

func UnmarshalGetSecretLocks(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetSecretLocks unmarshals an instance of GetSecretLocks from the specified map of raw messages.

func UnmarshalGetSecretPolicies added in v1.0.22

func UnmarshalGetSecretPolicies(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetSecretPolicies unmarshals an instance of GetSecretPolicies from the specified map of raw messages.

func UnmarshalGetSecretPolicyRotation added in v1.0.22

func UnmarshalGetSecretPolicyRotation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetSecretPolicyRotation unmarshals an instance of GetSecretPolicyRotation from the specified map of raw messages.

func UnmarshalGetSecretVersion added in v1.0.22

func UnmarshalGetSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetSecretVersion unmarshals an instance of GetSecretVersion from the specified map of raw messages.

func UnmarshalGetSecretVersionMetadata added in v1.0.22

func UnmarshalGetSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetSecretVersionMetadata unmarshals an instance of GetSecretVersionMetadata from the specified map of raw messages.

func UnmarshalGetSingleConfigElement added in v1.0.25

func UnmarshalGetSingleConfigElement(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetSingleConfigElement unmarshals an instance of GetSingleConfigElement from the specified map of raw messages.

func UnmarshalIamCredentialsSecretEngineRootConfig added in v1.0.22

func UnmarshalIamCredentialsSecretEngineRootConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIamCredentialsSecretEngineRootConfig unmarshals an instance of IamCredentialsSecretEngineRootConfig from the specified map of raw messages.

func UnmarshalIamCredentialsSecretMetadata added in v1.0.22

func UnmarshalIamCredentialsSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIamCredentialsSecretMetadata unmarshals an instance of IamCredentialsSecretMetadata from the specified map of raw messages.

func UnmarshalIamCredentialsSecretResource added in v1.0.22

func UnmarshalIamCredentialsSecretResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIamCredentialsSecretResource unmarshals an instance of IamCredentialsSecretResource from the specified map of raw messages.

func UnmarshalIamCredentialsSecretVersion added in v1.0.28

func UnmarshalIamCredentialsSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIamCredentialsSecretVersion unmarshals an instance of IamCredentialsSecretVersion from the specified map of raw messages.

func UnmarshalIamCredentialsSecretVersionInfo added in v1.0.28

func UnmarshalIamCredentialsSecretVersionInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIamCredentialsSecretVersionInfo unmarshals an instance of IamCredentialsSecretVersionInfo from the specified map of raw messages.

func UnmarshalIamCredentialsSecretVersionMetadata added in v1.0.22

func UnmarshalIamCredentialsSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIamCredentialsSecretVersionMetadata unmarshals an instance of IamCredentialsSecretVersionMetadata from the specified map of raw messages.

func UnmarshalInstanceSecretsLocks added in v1.0.45

func UnmarshalInstanceSecretsLocks(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalInstanceSecretsLocks unmarshals an instance of InstanceSecretsLocks from the specified map of raw messages.

func UnmarshalIntermediateCertificateAuthoritiesConfig added in v1.0.39

func UnmarshalIntermediateCertificateAuthoritiesConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIntermediateCertificateAuthoritiesConfig unmarshals an instance of IntermediateCertificateAuthoritiesConfig from the specified map of raw messages.

func UnmarshalIntermediateCertificateAuthoritiesConfigItem added in v1.0.39

func UnmarshalIntermediateCertificateAuthoritiesConfigItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIntermediateCertificateAuthoritiesConfigItem unmarshals an instance of IntermediateCertificateAuthoritiesConfigItem from the specified map of raw messages.

func UnmarshalIntermediateCertificateAuthorityConfig added in v1.0.39

func UnmarshalIntermediateCertificateAuthorityConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIntermediateCertificateAuthorityConfig unmarshals an instance of IntermediateCertificateAuthorityConfig from the specified map of raw messages.

func UnmarshalIssuanceInfo added in v1.0.25

func UnmarshalIssuanceInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIssuanceInfo unmarshals an instance of IssuanceInfo from the specified map of raw messages.

func UnmarshalKvSecretMetadata added in v1.0.30

func UnmarshalKvSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalKvSecretMetadata unmarshals an instance of KvSecretMetadata from the specified map of raw messages.

func UnmarshalKvSecretResource added in v1.0.30

func UnmarshalKvSecretResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalKvSecretResource unmarshals an instance of KvSecretResource from the specified map of raw messages.

func UnmarshalListSecretLocks added in v1.0.45

func UnmarshalListSecretLocks(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListSecretLocks unmarshals an instance of ListSecretLocks from the specified map of raw messages.

func UnmarshalListSecretVersions added in v1.0.28

func UnmarshalListSecretVersions(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListSecretVersions unmarshals an instance of ListSecretVersions from the specified map of raw messages.

func UnmarshalListSecrets

func UnmarshalListSecrets(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListSecrets unmarshals an instance of ListSecrets from the specified map of raw messages.

func UnmarshalLockSecretBodyLocksItem added in v1.0.45

func UnmarshalLockSecretBodyLocksItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLockSecretBodyLocksItem unmarshals an instance of LockSecretBodyLocksItem from the specified map of raw messages.

func UnmarshalNotificationsSettings added in v1.0.28

func UnmarshalNotificationsSettings(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationsSettings unmarshals an instance of NotificationsSettings from the specified map of raw messages.

func UnmarshalPrivateCertPolicyRotation added in v1.0.39

func UnmarshalPrivateCertPolicyRotation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPrivateCertPolicyRotation unmarshals an instance of PrivateCertPolicyRotation from the specified map of raw messages.

func UnmarshalPrivateCertSecretEngineRootConfig added in v1.0.39

func UnmarshalPrivateCertSecretEngineRootConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPrivateCertSecretEngineRootConfig unmarshals an instance of PrivateCertSecretEngineRootConfig from the specified map of raw messages.

func UnmarshalPrivateCertificateSecretMetadata added in v1.0.37

func UnmarshalPrivateCertificateSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPrivateCertificateSecretMetadata unmarshals an instance of PrivateCertificateSecretMetadata from the specified map of raw messages.

func UnmarshalPrivateCertificateSecretResource added in v1.0.39

func UnmarshalPrivateCertificateSecretResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPrivateCertificateSecretResource unmarshals an instance of PrivateCertificateSecretResource from the specified map of raw messages.

func UnmarshalPrivateCertificateSecretVersion added in v1.0.39

func UnmarshalPrivateCertificateSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPrivateCertificateSecretVersion unmarshals an instance of PrivateCertificateSecretVersion from the specified map of raw messages.

func UnmarshalPrivateCertificateSecretVersionInfo added in v1.0.39

func UnmarshalPrivateCertificateSecretVersionInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPrivateCertificateSecretVersionInfo unmarshals an instance of PrivateCertificateSecretVersionInfo from the specified map of raw messages.

func UnmarshalPrivateCertificateSecretVersionMetadata added in v1.0.39

func UnmarshalPrivateCertificateSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPrivateCertificateSecretVersionMetadata unmarshals an instance of PrivateCertificateSecretVersionMetadata from the specified map of raw messages.

func UnmarshalPublicCertSecretEngineRootConfig added in v1.0.25

func UnmarshalPublicCertSecretEngineRootConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPublicCertSecretEngineRootConfig unmarshals an instance of PublicCertSecretEngineRootConfig from the specified map of raw messages.

func UnmarshalPublicCertificateSecretMetadata added in v1.0.28

func UnmarshalPublicCertificateSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPublicCertificateSecretMetadata unmarshals an instance of PublicCertificateSecretMetadata from the specified map of raw messages.

func UnmarshalPublicCertificateSecretResource added in v1.0.25

func UnmarshalPublicCertificateSecretResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPublicCertificateSecretResource unmarshals an instance of PublicCertificateSecretResource from the specified map of raw messages.

func UnmarshalRestoreIamCredentialsSecretBody added in v1.0.28

func UnmarshalRestoreIamCredentialsSecretBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRestoreIamCredentialsSecretBody unmarshals an instance of RestoreIamCredentialsSecretBody from the specified map of raw messages.

func UnmarshalRevokeAction added in v1.0.39

func UnmarshalRevokeAction(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRevokeAction unmarshals an instance of RevokeAction from the specified map of raw messages.

func UnmarshalRevokeActionResult added in v1.0.39

func UnmarshalRevokeActionResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRevokeActionResult unmarshals an instance of RevokeActionResult from the specified map of raw messages.

func UnmarshalRootCertificateAuthoritiesConfig added in v1.0.39

func UnmarshalRootCertificateAuthoritiesConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRootCertificateAuthoritiesConfig unmarshals an instance of RootCertificateAuthoritiesConfig from the specified map of raw messages.

func UnmarshalRootCertificateAuthoritiesConfigItem added in v1.0.39

func UnmarshalRootCertificateAuthoritiesConfigItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRootCertificateAuthoritiesConfigItem unmarshals an instance of RootCertificateAuthoritiesConfigItem from the specified map of raw messages.

func UnmarshalRootCertificateAuthorityConfig added in v1.0.39

func UnmarshalRootCertificateAuthorityConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRootCertificateAuthorityConfig unmarshals an instance of RootCertificateAuthorityConfig from the specified map of raw messages.

func UnmarshalRotateArbitrarySecretBody added in v1.0.22

func UnmarshalRotateArbitrarySecretBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotateArbitrarySecretBody unmarshals an instance of RotateArbitrarySecretBody from the specified map of raw messages.

func UnmarshalRotateCertificateBody added in v1.0.22

func UnmarshalRotateCertificateBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotateCertificateBody unmarshals an instance of RotateCertificateBody from the specified map of raw messages.

func UnmarshalRotateCrlActionResult added in v1.0.39

func UnmarshalRotateCrlActionResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotateCrlActionResult unmarshals an instance of RotateCrlActionResult from the specified map of raw messages.

func UnmarshalRotateKvSecretBody added in v1.0.30

func UnmarshalRotateKvSecretBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotateKvSecretBody unmarshals an instance of RotateKvSecretBody from the specified map of raw messages.

func UnmarshalRotatePrivateCertBody added in v1.0.46

func UnmarshalRotatePrivateCertBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotatePrivateCertBody unmarshals an instance of RotatePrivateCertBody from the specified map of raw messages.

func UnmarshalRotatePrivateCertBodyWithCsr added in v1.0.48

func UnmarshalRotatePrivateCertBodyWithCsr(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotatePrivateCertBodyWithCsr unmarshals an instance of RotatePrivateCertBodyWithCsr from the specified map of raw messages.

func UnmarshalRotatePrivateCertBodyWithVersionCustomMetadata added in v1.0.46

func UnmarshalRotatePrivateCertBodyWithVersionCustomMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotatePrivateCertBodyWithVersionCustomMetadata unmarshals an instance of RotatePrivateCertBodyWithVersionCustomMetadata from the specified map of raw messages.

func UnmarshalRotatePublicCertBody added in v1.0.25

func UnmarshalRotatePublicCertBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotatePublicCertBody unmarshals an instance of RotatePublicCertBody from the specified map of raw messages.

func UnmarshalRotateUsernamePasswordSecretBody added in v1.0.22

func UnmarshalRotateUsernamePasswordSecretBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotateUsernamePasswordSecretBody unmarshals an instance of RotateUsernamePasswordSecretBody from the specified map of raw messages.

func UnmarshalRotation added in v1.0.25

func UnmarshalRotation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRotation unmarshals an instance of Rotation from the specified map of raw messages.

func UnmarshalSecretAction added in v1.0.22

func UnmarshalSecretAction(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretAction unmarshals an instance of SecretAction from the specified map of raw messages.

func UnmarshalSecretGroupDef

func UnmarshalSecretGroupDef(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretGroupDef unmarshals an instance of SecretGroupDef from the specified map of raw messages.

func UnmarshalSecretGroupMetadataUpdatable

func UnmarshalSecretGroupMetadataUpdatable(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretGroupMetadataUpdatable unmarshals an instance of SecretGroupMetadataUpdatable from the specified map of raw messages.

func UnmarshalSecretGroupResource

func UnmarshalSecretGroupResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretGroupResource unmarshals an instance of SecretGroupResource from the specified map of raw messages.

func UnmarshalSecretLockData added in v1.0.45

func UnmarshalSecretLockData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretLockData unmarshals an instance of SecretLockData from the specified map of raw messages.

func UnmarshalSecretLockVersion added in v1.0.45

func UnmarshalSecretLockVersion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretLockVersion unmarshals an instance of SecretLockVersion from the specified map of raw messages.

func UnmarshalSecretMetadata

func UnmarshalSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretMetadata unmarshals an instance of SecretMetadata from the specified map of raw messages.

func UnmarshalSecretMetadataRequest

func UnmarshalSecretMetadataRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretMetadataRequest unmarshals an instance of SecretMetadataRequest from the specified map of raw messages.

func UnmarshalSecretPolicyRotation

func UnmarshalSecretPolicyRotation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretPolicyRotation unmarshals an instance of SecretPolicyRotation from the specified map of raw messages.

func UnmarshalSecretPolicyRotationRotation

func UnmarshalSecretPolicyRotationRotation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretPolicyRotationRotation unmarshals an instance of SecretPolicyRotationRotation from the specified map of raw messages.

func UnmarshalSecretPolicyRotationRotationPolicyRotation added in v1.0.25

func UnmarshalSecretPolicyRotationRotationPolicyRotation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretPolicyRotationRotationPolicyRotation unmarshals an instance of SecretPolicyRotationRotationPolicyRotation from the specified map of raw messages.

func UnmarshalSecretPolicyRotationRotationPublicCertPolicyRotation added in v1.0.25

func UnmarshalSecretPolicyRotationRotationPublicCertPolicyRotation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretPolicyRotationRotationPublicCertPolicyRotation unmarshals an instance of SecretPolicyRotationRotationPublicCertPolicyRotation from the specified map of raw messages.

func UnmarshalSecretResource

func UnmarshalSecretResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretResource unmarshals an instance of SecretResource from the specified map of raw messages.

func UnmarshalSecretVersion

func UnmarshalSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretVersion unmarshals an instance of SecretVersion from the specified map of raw messages.

func UnmarshalSecretVersionInfo added in v1.0.28

func UnmarshalSecretVersionInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretVersionInfo unmarshals an instance of SecretVersionInfo from the specified map of raw messages.

func UnmarshalSecretVersionMetadata added in v1.0.22

func UnmarshalSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretVersionMetadata unmarshals an instance of SecretVersionMetadata from the specified map of raw messages.

func UnmarshalSecretsLocks added in v1.0.45

func UnmarshalSecretsLocks(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretsLocks unmarshals an instance of SecretsLocks from the specified map of raw messages.

func UnmarshalSetSignedAction added in v1.0.39

func UnmarshalSetSignedAction(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSetSignedAction unmarshals an instance of SetSignedAction from the specified map of raw messages.

func UnmarshalSetSignedActionResult added in v1.0.39

func UnmarshalSetSignedActionResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSetSignedActionResult unmarshals an instance of SetSignedActionResult from the specified map of raw messages.

func UnmarshalSignActionResultData added in v1.0.39

func UnmarshalSignActionResultData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSignActionResultData unmarshals an instance of SignActionResultData from the specified map of raw messages.

func UnmarshalSignCsrAction added in v1.0.39

func UnmarshalSignCsrAction(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSignCsrAction unmarshals an instance of SignCsrAction from the specified map of raw messages.

func UnmarshalSignCsrActionResult added in v1.0.39

func UnmarshalSignCsrActionResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSignCsrActionResult unmarshals an instance of SignCsrActionResult from the specified map of raw messages.

func UnmarshalSignIntermediateAction added in v1.0.39

func UnmarshalSignIntermediateAction(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSignIntermediateAction unmarshals an instance of SignIntermediateAction from the specified map of raw messages.

func UnmarshalSignIntermediateActionResult added in v1.0.39

func UnmarshalSignIntermediateActionResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSignIntermediateActionResult unmarshals an instance of SignIntermediateActionResult from the specified map of raw messages.

func UnmarshalSignIntermediateActionResultData added in v1.0.39

func UnmarshalSignIntermediateActionResultData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSignIntermediateActionResultData unmarshals an instance of SignIntermediateActionResultData from the specified map of raw messages.

func UnmarshalUpdateSecretVersionMetadata added in v1.0.46

func UnmarshalUpdateSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUpdateSecretVersionMetadata unmarshals an instance of UpdateSecretVersionMetadata from the specified map of raw messages.

func UnmarshalUsernamePasswordSecretMetadata added in v1.0.22

func UnmarshalUsernamePasswordSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUsernamePasswordSecretMetadata unmarshals an instance of UsernamePasswordSecretMetadata from the specified map of raw messages.

func UnmarshalUsernamePasswordSecretResource added in v1.0.22

func UnmarshalUsernamePasswordSecretResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUsernamePasswordSecretResource unmarshals an instance of UsernamePasswordSecretResource from the specified map of raw messages.

func UnmarshalUsernamePasswordSecretVersion added in v1.0.28

func UnmarshalUsernamePasswordSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUsernamePasswordSecretVersion unmarshals an instance of UsernamePasswordSecretVersion from the specified map of raw messages.

func UnmarshalUsernamePasswordSecretVersionInfo added in v1.0.28

func UnmarshalUsernamePasswordSecretVersionInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUsernamePasswordSecretVersionInfo unmarshals an instance of UsernamePasswordSecretVersionInfo from the specified map of raw messages.

func UnmarshalUsernamePasswordSecretVersionMetadata added in v1.0.22

func UnmarshalUsernamePasswordSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUsernamePasswordSecretVersionMetadata unmarshals an instance of UsernamePasswordSecretVersionMetadata from the specified map of raw messages.

Types

type ActionOnConfigElementOptions added in v1.0.39

type ActionOnConfigElementOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The configuration element on which the action is applied.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

	// The name of the certificate authority.
	ConfigName *string `json:"config_name" validate:"required,ne="`

	// The action to perform on the specified configuration element.
	Action *string `json:"action" validate:"required"`

	// Properties that describe an action on a configuration element.
	Config ConfigActionIntf `json:"config,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ActionOnConfigElementOptions : The ActionOnConfigElement options.

func (*ActionOnConfigElementOptions) SetAction added in v1.0.39

SetAction : Allow user to set Action

func (*ActionOnConfigElementOptions) SetConfig added in v1.0.39

SetConfig : Allow user to set Config

func (*ActionOnConfigElementOptions) SetConfigElement added in v1.0.39

func (_options *ActionOnConfigElementOptions) SetConfigElement(configElement string) *ActionOnConfigElementOptions

SetConfigElement : Allow user to set ConfigElement

func (*ActionOnConfigElementOptions) SetConfigName added in v1.0.39

func (_options *ActionOnConfigElementOptions) SetConfigName(configName string) *ActionOnConfigElementOptions

SetConfigName : Allow user to set ConfigName

func (*ActionOnConfigElementOptions) SetHeaders added in v1.0.39

SetHeaders : Allow user to set Headers

func (*ActionOnConfigElementOptions) SetSecretType added in v1.0.39

func (_options *ActionOnConfigElementOptions) SetSecretType(secretType string) *ActionOnConfigElementOptions

SetSecretType : Allow user to set SecretType

type ArbitrarySecretMetadata added in v1.0.22

type ArbitrarySecretMetadata struct {
	// The unique ID of the secret.
	ID *string `json:"id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be in the range 2 - 30 characters, including spaces. Special characters
	// that are not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies the resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when any part of the secret metadata is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The date the secret material expires. The date format follows RFC 3339.
	//
	// You can set an expiration date on supported secret types at their creation. If you create a secret without
	// specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
	// following secret types:
	//
	// - `arbitrary`
	// - `username_password`.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
}

ArbitrarySecretMetadata : Metadata properties that describe an arbitrary secret. This model "extends" SecretMetadata

type ArbitrarySecretResource added in v1.0.22

type ArbitrarySecretResource struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be 2 - 30 characters, including spaces. Special characters that are not
	// permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// An array that contains metadata for each secret version. For more information on the metadata properties, see [Get
	// secret version metadata](#get-secret-version-metadata).
	Versions []map[string]interface{} `json:"versions,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The date the secret material expires. The date format follows RFC 3339.
	//
	// You can set an expiration date on supported secret types at their creation. If you create a secret without
	// specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
	// following secret types:
	//
	// - `arbitrary`
	// - `username_password`.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The new secret data to assign to the secret.
	Payload interface{} `json:"payload,omitempty"`

	// The data that is associated with the secret version.
	//
	// The data object contains the field `payload`.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`
}

ArbitrarySecretResource : Properties that describe a secret. This model "extends" SecretResource

type ArbitrarySecretVersion added in v1.0.28

type ArbitrarySecretVersion struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The data that is associated with the secret version.
	//
	// The data object contains the field `payload`.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`
}

ArbitrarySecretVersion : ArbitrarySecretVersion struct This model "extends" SecretVersion

type ArbitrarySecretVersionInfo added in v1.0.28

type ArbitrarySecretVersionInfo struct {
	// The ID of the secret version.
	ID *string `json:"id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

ArbitrarySecretVersionInfo : ArbitrarySecretVersionInfo struct This model "extends" SecretVersionInfo

type ArbitrarySecretVersionMetadata added in v1.0.22

type ArbitrarySecretVersionMetadata struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

ArbitrarySecretVersionMetadata : Properties that describe a secret version. This model "extends" SecretVersionMetadata

type CertificateSecretData added in v1.0.22

type CertificateSecretData struct {
	// contains filtered or unexported fields
}

CertificateSecretData : The data that is associated with the secret version. The data object contains the following fields:

- `certificate`: The contents of the certificate. - `private_key`: The private key that is associated with the certificate. - `intermediate`: The intermediate certificate that is associated with the certificate.

func (*CertificateSecretData) GetProperties added in v1.0.47

func (o *CertificateSecretData) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of CertificateSecretData

func (*CertificateSecretData) GetProperty added in v1.0.47

func (o *CertificateSecretData) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of CertificateSecretData

func (*CertificateSecretData) MarshalJSON added in v1.0.47

func (o *CertificateSecretData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of CertificateSecretData

func (*CertificateSecretData) SetProperties added in v1.0.47

func (o *CertificateSecretData) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of CertificateSecretData

func (*CertificateSecretData) SetProperty added in v1.0.47

func (o *CertificateSecretData) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of CertificateSecretData

type CertificateSecretMetadata added in v1.0.22

type CertificateSecretMetadata struct {
	// The unique ID of the secret.
	ID *string `json:"id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be in the range 2 - 30 characters, including spaces. Special characters
	// that are not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies the resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when any part of the secret metadata is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign the
	// certificate.
	Algorithm *string `json:"algorithm,omitempty"`

	// The identifier for the cryptographic algorithm that was used to generate the public and private keys that are
	// associated with the certificate.
	KeyAlgorithm *string `json:"key_algorithm,omitempty"`

	// The distinguished name that identifies the entity that signed and issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The fully qualified domain name or host domain name that is defined for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// Indicates whether the certificate was imported with an associated intermediate certificate.
	IntermediateIncluded *bool `json:"intermediate_included,omitempty"`

	// Indicates whether the certificate was imported with an associated private key.
	PrivateKeyIncluded *bool `json:"private_key_included,omitempty"`

	// The alternative names that are defined for the certificate.
	AltNames []string `json:"alt_names,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
}

CertificateSecretMetadata : Metadata properties that describe a certificate secret. This model "extends" SecretMetadata

type CertificateSecretResource added in v1.0.22

type CertificateSecretResource struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be 2 - 30 characters, including spaces. Special characters that are not
	// permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// An array that contains metadata for each secret version. For more information on the metadata properties, see [Get
	// secret version metadata](#get-secret-version-metadata).
	Versions []map[string]interface{} `json:"versions,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The contents of your certificate. The data must be formatted on a single line with embedded newline characters.
	Certificate *string `json:"certificate,omitempty"`

	// The private key to associate with the certificate. The data must be formatted on a single line with embedded newline
	// characters.
	PrivateKey *string `json:"private_key,omitempty"`

	// The intermediate certificate to associate with the root certificate. The data must be formatted on a single line
	// with embedded newline characters.
	Intermediate *string `json:"intermediate,omitempty"`

	// The data that is associated with the secret. The data object contains the following fields:
	//
	// - `certificate`: The contents of the certificate.
	// - `private_key`: The private key that is associated with the certificate.
	// - `intermediate`: The intermediate certificate that is associated with the certificate.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign the
	// certificate.
	Algorithm *string `json:"algorithm,omitempty"`

	// The identifier for the cryptographic algorithm that was used to generate the public and private keys that are
	// associated with the certificate.
	KeyAlgorithm *string `json:"key_algorithm,omitempty"`

	// The distinguished name that identifies the entity that signed and issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The fully qualified domain name or host domain name that is defined for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// Indicates whether the certificate was imported with an associated intermediate certificate.
	IntermediateIncluded *bool `json:"intermediate_included,omitempty"`

	// Indicates whether the certificate was imported with an associated private key.
	PrivateKeyIncluded *bool `json:"private_key_included,omitempty"`

	// The alternative names that are defined for the certificate.
	//
	// For public certificates, this value is provided as an array of strings. For private certificates, this value is
	// provided as a comma-delimited list (string). In the API response, this value is returned as an array of strings for
	// all the types of certificate secrets.
	AltNames interface{} `json:"alt_names,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
}

CertificateSecretResource : Properties that describe a secret. This model "extends" SecretResource

type CertificateSecretVersion added in v1.0.22

type CertificateSecretVersion struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The data that is associated with the secret version. The data object contains the following fields:
	//
	// - `certificate`: The contents of the certificate.
	// - `private_key`: The private key that is associated with the certificate.
	// - `intermediate`: The intermediate certificate that is associated with the certificate.
	SecretData *CertificateSecretData `json:"secret_data,omitempty"`
}

CertificateSecretVersion : CertificateSecretVersion struct This model "extends" SecretVersion

type CertificateSecretVersionInfo added in v1.0.28

type CertificateSecretVersionInfo struct {
	// The ID of the secret version.
	ID *string `json:"id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`
}

CertificateSecretVersionInfo : CertificateSecretVersionInfo struct This model "extends" SecretVersionInfo

type CertificateSecretVersionMetadata added in v1.0.22

type CertificateSecretVersionMetadata struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`
}

CertificateSecretVersionMetadata : Properties that describe a secret version. This model "extends" SecretVersionMetadata

type CertificateTemplateConfig added in v1.0.39

type CertificateTemplateConfig struct {
	// The name of the intermediate certificate authority.
	CertificateAuthority *string `json:"certificate_authority" validate:"required"`

	// Scopes the creation of private certificates to only the secret groups that you specify.
	//
	// This field can be supplied as a comma-delimited list of secret group IDs.
	AllowedSecretGroups *string `json:"allowed_secret_groups,omitempty"`

	// The maximum time-to-live (TTL) for certificates that are created by this CA.
	//
	// The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
	// response, this value is returned in seconds (integer).
	//
	// Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).
	MaxTTL interface{} `json:"max_ttl,omitempty"`

	// The time-to-live (TTL) to assign to a private certificate.
	//
	// The value can be supplied as a string representation of a duration, such as `12h`. The value can be supplied in
	// seconds (suffix `s`), minutes (suffix `m`) or hours (suffix `h`). The value can't exceed the `max_ttl` that is
	// defined in the associated certificate template. In the API response, this value is returned in seconds (integer).
	TTL interface{} `json:"ttl,omitempty"`

	// Determines whether to allow `localhost` to be included as one of the requested common names.
	AllowLocalhost *bool `json:"allow_localhost,omitempty"`

	// The domains to define for the certificate template. This property is used along with the `allow_bare_domains` and
	// `allow_subdomains` options.
	AllowedDomains []string `json:"allowed_domains,omitempty"`

	// Determines whether to allow the domains that are supplied in the `allowed_domains` field to contain access control
	// list (ACL) templates.
	AllowedDomainsTemplate *bool `json:"allowed_domains_template,omitempty"`

	// Determines whether to allow clients to request private certificates that match the value of the actual domains on
	// the final certificate.
	//
	// For example, if you specify `example.com` in the `allowed_domains` field, you grant clients the ability to request a
	// certificate that contains the name `example.com` as one of the DNS values on the final certificate.
	//
	// **Important:** In some scenarios, allowing bare domains can be considered a security risk.
	AllowBareDomains *bool `json:"allow_bare_domains,omitempty"`

	// Determines whether to allow clients to request private certificates with common names (CN) that are subdomains of
	// the CNs that are allowed by the other certificate template options. This includes wildcard subdomains.
	//
	// For example, if `allowed_domains` has a value of `example.com` and `allow_subdomains`is set to `true`, then the
	// following subdomains are allowed: `foo.example.com`, `bar.example.com`, `*.example.com`.
	//
	// **Note:** This field is redundant if you use the `allow_any_name` option.
	AllowSubdomains *bool `json:"allow_subdomains,omitempty"`

	// Determines whether to allow glob patterns, for example, `ftp*.example.com`, in the names that are specified in the
	// `allowed_domains` field.
	//
	// If set to `true`, clients are allowed to request private certificates with names that match the glob patterns.
	AllowGlobDomains *bool `json:"allow_glob_domains,omitempty"`

	// Determines whether to allow clients to request a private certificate that matches any common name.
	AllowAnyName *bool `json:"allow_any_name,omitempty"`

	// Determines whether to enforce only valid host names for common names, DNS Subject Alternative Names, and the host
	// section of email addresses.
	EnforceHostnames *bool `json:"enforce_hostnames,omitempty"`

	// Determines whether to allow clients to request a private certificate with IP Subject Alternative Names.
	AllowIPSans *bool `json:"allow_ip_sans,omitempty"`

	// The URI Subject Alternative Names to allow for private certificates.
	//
	// Values can contain glob patterns, for example `spiffe://hostname/_*`.
	AllowedURISans []string `json:"allowed_uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names (SANs) to allow for private
	// certificates.
	//
	// The format for each element in the list is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type
	// is `UTF8`. To allow any value for an OID, use `*` as its value. Alternatively, specify a single `*` to allow any
	// `other_sans` input.
	AllowedOtherSans []string `json:"allowed_other_sans,omitempty"`

	// Determines whether private certificates are flagged for server use.
	ServerFlag *bool `json:"server_flag,omitempty"`

	// Determines whether private certificates are flagged for client use.
	ClientFlag *bool `json:"client_flag,omitempty"`

	// Determines whether private certificates are flagged for code signing use.
	CodeSigningFlag *bool `json:"code_signing_flag,omitempty"`

	// Determines whether private certificates are flagged for email protection use.
	EmailProtectionFlag *bool `json:"email_protection_flag,omitempty"`

	// The type of private key to generate for private certificates and the type of key that is expected for submitted
	// certificate signing requests (CSRs).
	//
	// Allowable values are: `rsa` and `ec`.
	KeyType *string `json:"key_type,omitempty"`

	// The number of bits to use when generating the private key.
	//
	// Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and
	// `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.
	KeyBits *int64 `json:"key_bits,omitempty"`

	// The allowed key usage constraint to define for private certificates.
	//
	// You can find valid values in the [Go x509 package documentation](https://pkg.go.dev/crypto/x509#KeyUsage).  Omit the
	// `KeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to
	// an empty list.
	KeyUsage []string `json:"key_usage,omitempty"`

	// The allowed extended key usage constraint on private certificates.
	//
	// You can find valid values in the [Go x509 package documentation](https://golang.org/pkg/crypto/x509/#ExtKeyUsage).
	// Omit the `ExtKeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set
	// this field to an empty list.
	ExtKeyUsage []string `json:"ext_key_usage,omitempty"`

	// A list of extended key usage Object Identifiers (OIDs).
	ExtKeyUsageOids []string `json:"ext_key_usage_oids,omitempty"`

	// When used with the `sign_csr` action, this field determines whether to use the common name (CN) from a certificate
	// signing request (CSR) instead of the CN that's included in the JSON data of the certificate.
	//
	// Does not include any requested Subject Alternative Names (SANs) in the CSR. To use the alternative names, include
	// the `use_csr_sans` property.
	UseCsrCommonName *bool `json:"use_csr_common_name,omitempty"`

	// When used with the `sign_csr` action, this field determines whether to use the Subject Alternative Names
	// (SANs) from a certificate signing request (CSR) instead of the SANs that are included in the JSON data of the
	// certificate.
	//
	// Does not include the common name in the CSR. To use the common name, include the `use_csr_common_name` property.
	UseCsrSans *bool `json:"use_csr_sans,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Determines whether to require a common name to create a private certificate.
	//
	// By default, a common name is required to generate a certificate. To make the `common_name` field optional, set the
	// `require_cn` option to `false`.
	RequireCn *bool `json:"require_cn,omitempty"`

	// A list of policy Object Identifiers (OIDs).
	PolicyIdentifiers []string `json:"policy_identifiers,omitempty"`

	// Determines whether to mark the Basic Constraints extension of an issued private certificate as valid for non-CA
	// certificates.
	BasicConstraintsValidForNonCa *bool `json:"basic_constraints_valid_for_non_ca,omitempty"`

	// The duration in seconds by which to backdate the `not_before` property of an issued private certificate.
	//
	// The value can be supplied as a string representation of a duration, such as `30s`. In the API response, this value
	// is returned in seconds (integer).
	NotBeforeDuration interface{} `json:"not_before_duration,omitempty"`
}

CertificateTemplateConfig : Properties that describe a certificate template. You can use a certificate template to control the parameters that are applied to your issued private certificates. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates). This model "extends" ConfigElementDefConfig

type CertificateTemplatesConfig added in v1.0.42

type CertificateTemplatesConfig struct {
	CertificateTemplates []CertificateTemplatesConfigItem `json:"certificate_templates" validate:"required"`
}

CertificateTemplatesConfig : Certificate templates configuration. This model "extends" GetConfigElementsResourcesItem

type CertificateTemplatesConfigItem added in v1.0.42

type CertificateTemplatesConfigItem struct {
	// The human-readable name to assign to your configuration.
	Name *string `json:"name" validate:"required"`

	// The type of configuration. Value options differ depending on the `config_element` property that you want to define.
	Type *string `json:"type" validate:"required"`

	// Properties that describe a certificate template. You can use a certificate template to control the parameters that
	// are applied to your issued private certificates. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates).
	Config *CertificateTemplateConfig `json:"config,omitempty"`
}

CertificateTemplatesConfigItem : Certificate templates configuration.

type CertificateValidity added in v1.0.22

type CertificateValidity struct {
	// The date and time that the certificate validity period begins.
	NotBefore *strfmt.DateTime `json:"not_before,omitempty"`

	// The date and time that the certificate validity period ends.
	NotAfter *strfmt.DateTime `json:"not_after,omitempty"`
}

CertificateValidity : CertificateValidity struct

type ChallengeResource added in v1.0.47

type ChallengeResource struct {
	// The challenge domain.
	Domain *string `json:"domain,omitempty"`

	// The challenge expiration date. The date format follows RFC 3339.
	Expiration *strfmt.DateTime `json:"expiration,omitempty"`

	// The challenge status.
	Status *string `json:"status,omitempty"`

	// The txt_record_name.
	TxtRecordName *string `json:"txt_record_name,omitempty"`

	// The txt_record_value.
	TxtRecordValue *string `json:"txt_record_value,omitempty"`
}

ChallengeResource : Properties that describe a challenge.

type CollectionMetadata

type CollectionMetadata struct {
	// The type of resources in the resource array.
	CollectionType *string `json:"collection_type" validate:"required"`

	// The number of elements in the resource array.
	CollectionTotal *int64 `json:"collection_total" validate:"required"`
}

CollectionMetadata : The metadata that describes the resource array.

type ConfigAction added in v1.0.39

type ConfigAction struct {
	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to a private certificate.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `12h`. The value can't exceed
	// the `max_ttl` that is defined in the associated certificate template.
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The maximum path length to encode in the generated certificate. `-1` means no limit.
	//
	// If the signing certificate has a maximum path length set, the path length is set to one less than that of the
	// signing certificate. A limit of `0` means a literal path length of zero.
	MaxPathLength *int64 `json:"max_path_length,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The allowed DNS domains or subdomains for the certificates to be signed and issued by this CA certificate.
	PermittedDNSDomains []string `json:"permitted_dns_domains,omitempty"`

	// Determines whether to use values from a certificate signing request (CSR) to complete a `sign_csr` action. If set to
	// `true`, then:
	//
	// 1) Subject information, including names and alternate names, are preserved from the CSR rather than using the values
	// provided in the other parameters to this operation.
	//
	// 2) Any key usages (for example, non-repudiation) that are requested in the CSR are added to the basic set of key
	// usages used for CA certs signed by this intermediate authority.
	//
	// 3) Extensions that are requested in the CSR are copied into the issued private certificate.
	UseCsrValues *bool `json:"use_csr_values,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The PEM-encoded certificate signing request (CSR). This field is required for the `sign_csr` action.
	Csr *string `json:"csr,omitempty"`

	// The intermediate certificate authority to be signed. The name must match one of the pre-configured intermediate
	// certificate authorities.
	IntermediateCertificateAuthority *string `json:"intermediate_certificate_authority,omitempty"`

	// The PEM-encoded certificate.
	Certificate *string `json:"certificate,omitempty"`
}

ConfigAction : Properties that describe an action on a configuration element. Models which "extend" this model: - SignCsrAction - SignIntermediateAction - SetSignedAction - RevokeAction

type ConfigActionIntf added in v1.0.39

type ConfigActionIntf interface {
	// contains filtered or unexported methods
}

type ConfigElementActionData added in v1.0.39

type ConfigElementActionData struct {
	// The human-readable name to assign to your configuration.
	Name *string `json:"name" validate:"required"`

	// The type of configuration. Value options differ depending on the `config_element` property that you want to define.
	Type *string `json:"type" validate:"required"`

	Config ConfigElementActionResultConfigIntf `json:"config" validate:"required"`
}

ConfigElementActionData : The configuration to add or update.

type ConfigElementActionResult added in v1.0.39

type ConfigElementActionResult struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []ConfigElementActionData `json:"resources" validate:"required"`
}

ConfigElementActionResult : Properties that describe an action on a configuration element.

type ConfigElementActionResultConfig added in v1.0.39

type ConfigElementActionResultConfig struct {
	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to a private certificate.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `12h`. The value can't exceed
	// the `max_ttl` that is defined in the associated certificate template.
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The maximum path length to encode in the generated certificate. `-1` means no limit.
	//
	// If the signing certificate has a maximum path length set, the path length is set to one less than that of the
	// signing certificate. A limit of `0` means a literal path length of zero.
	MaxPathLength *int64 `json:"max_path_length,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The allowed DNS domains or subdomains for the certificates to be signed and issued by this CA certificate.
	PermittedDNSDomains []string `json:"permitted_dns_domains,omitempty"`

	// Determines whether to use values from a certificate signing request (CSR) to complete a `sign_csr` action. If set to
	// `true`, then:
	//
	// 1) Subject information, including names and alternate names, are preserved from the CSR rather than using the values
	// provided in the other parameters to this operation.
	//
	// 2) Any key usages (for example, non-repudiation) that are requested in the CSR are added to the basic set of key
	// usages used for CA certs signed by this intermediate authority.
	//
	// 3) Extensions that are requested in the CSR are copied into the issued private certificate.
	UseCsrValues *bool `json:"use_csr_values,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Properties that are returned with a successful `sign` action.
	Data *SignActionResultData `json:"data,omitempty"`

	// The PEM-encoded certificate signing request (CSR).
	Csr *string `json:"csr,omitempty"`

	// The signed intermediate certificate authority.
	IntermediateCertificateAuthority *string `json:"intermediate_certificate_authority,omitempty"`

	// The time until the certificate authority is revoked.
	RevocationTime *int64 `json:"revocation_time,omitempty"`
}

ConfigElementActionResultConfig : ConfigElementActionResultConfig struct Models which "extend" this model: - SignCsrActionResult - SignIntermediateActionResult - RotateCrlActionResult - SetSignedActionResult - RevokeActionResult

type ConfigElementActionResultConfigIntf added in v1.0.39

type ConfigElementActionResultConfigIntf interface {
	// contains filtered or unexported methods
}

type ConfigElementDef added in v1.0.25

type ConfigElementDef struct {
	// The human-readable name to assign to your configuration.
	Name *string `json:"name" validate:"required"`

	// The type of configuration. Value options differ depending on the `config_element` property that you want to define.
	Type *string `json:"type" validate:"required"`

	// The configuration to define for the specified secret type.
	Config ConfigElementDefConfigIntf `json:"config" validate:"required"`
}

ConfigElementDef : The configuration to add or update.

type ConfigElementDefConfig added in v1.0.25

type ConfigElementDefConfig struct {
	// The private key that is associated with your Automatic Certificate Management Environment (ACME) account.
	//
	// If you have a working ACME client or account for Let's Encrypt, you can use the existing private key to enable
	// communications with Secrets Manager. If you don't have an account yet, you can create one. For more information, see
	// the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#create-acme-account).
	PrivateKey *string `json:"private_key,omitempty"`

	// The Cloud Resource Name (CRN) that is associated with the CIS instance.
	CisCRN *string `json:"cis_crn,omitempty"`

	// An IBM Cloud API key that can to list domains in your CIS instance.
	//
	// To grant Secrets Manager the ability to view the CIS instance and all of its domains, the API key must be assigned
	// the Reader service role on Internet Services (`internet-svcs`).
	//
	// If you need to manage specific domains, you can assign the Manager role. For production environments, it is
	// recommended that you assign the Reader access role, and then use the
	// [IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy) to control specific
	// domains. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-specific-domains).
	CisApikey *string `json:"cis_apikey,omitempty"`

	// The username that is associated with your classic infrastructure account.
	//
	// In most cases, your classic infrastructure username is your `<account_id>_<email_address>`. For more information,
	// see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).
	ClassicInfrastructureUsername *string `json:"classic_infrastructure_username,omitempty"`

	// Your classic infrastructure API key.
	//
	// For information about viewing and accessing your classic infrastructure API key, see the
	// [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).
	ClassicInfrastructurePassword *string `json:"classic_infrastructure_password,omitempty"`

	// The maximum time-to-live (TTL) for certificates that are created by this CA.
	//
	// The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
	// response, this value is returned in seconds (integer).
	//
	// Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).
	MaxTTL interface{} `json:"max_ttl,omitempty"`

	// The time until the certificate revocation list (CRL) expires.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours.
	// In the API response, this value is returned in seconds (integer).
	//
	// **Note:** The CRL is rotated automatically before it expires.
	CrlExpiry interface{} `json:"crl_expiry,omitempty"`

	// Disables or enables certificate revocation list (CRL) building.
	//
	// If CRL building is disabled, a signed but zero-length CRL is returned when downloading the CRL. If CRL building is
	// enabled,  it will rebuild the CRL.
	CrlDisable *bool `json:"crl_disable,omitempty"`

	// Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are
	// issued by this certificate authority.
	CrlDistributionPointsEncoded *bool `json:"crl_distribution_points_encoded,omitempty"`

	// Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this
	// certificate authority.
	IssuingCertificatesUrlsEncoded *bool `json:"issuing_certificates_urls_encoded,omitempty"`

	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// The status of the certificate authority. The status of a root certificate authority is either `configured` or
	// `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,
	// `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
	Status *string `json:"status,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to this CA certificate.
	//
	// The value can be supplied as a string representation of a duration, such as `12h`. The value can be supplied in
	// seconds (suffix `s`), minutes (suffix `m`), hours (suffix `h`) or days (suffix `d`). The value can't exceed the
	// `max_ttl` that is defined in the associated certificate template. In the API response, this value is returned in
	// seconds (integer).
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The format of the generated private key.
	PrivateKeyFormat *string `json:"private_key_format,omitempty"`

	// The type of private key to generate.
	KeyType *string `json:"key_type,omitempty"`

	// The number of bits to use when generating the private key.
	//
	// Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and
	// `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.
	KeyBits *int64 `json:"key_bits,omitempty"`

	// The maximum path length to encode in the generated certificate. `-1` means no limit.
	//
	// If the signing certificate has a maximum path length set, the path length is set to one less than that of the
	// signing certificate. A limit of `0` means a literal path length of zero.
	MaxPathLength *int64 `json:"max_path_length,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The allowed DNS domains or subdomains for the certificates to be signed and issued by this CA certificate.
	PermittedDNSDomains []string `json:"permitted_dns_domains,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The data that is associated with the root certificate authority. The data object contains the following fields:
	//
	// - `certificate`: The root certificate content.
	// - `issuing_ca`: The certificate of the certificate authority that signed and issued this certificate.
	// - `serial_number`: The unique serial number of the root certificate.
	Data map[string]interface{} `json:"data,omitempty"`

	// The signing method to use with this certificate authority to generate private certificates.
	//
	// You can choose between internal or externally signed options. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).
	SigningMethod *string `json:"signing_method,omitempty"`

	// The certificate authority that signed and issued the certificate.
	//
	// If the certificate is signed internally, the `issuer` field is required and must match the name of a certificate
	// authority that is configured in the Secrets Manager service instance.
	Issuer *string `json:"issuer,omitempty"`

	// The name of the intermediate certificate authority.
	CertificateAuthority *string `json:"certificate_authority,omitempty"`

	// Scopes the creation of private certificates to only the secret groups that you specify.
	//
	// This field can be supplied as a comma-delimited list of secret group IDs.
	AllowedSecretGroups *string `json:"allowed_secret_groups,omitempty"`

	// Determines whether to allow `localhost` to be included as one of the requested common names.
	AllowLocalhost *bool `json:"allow_localhost,omitempty"`

	// The domains to define for the certificate template. This property is used along with the `allow_bare_domains` and
	// `allow_subdomains` options.
	AllowedDomains []string `json:"allowed_domains,omitempty"`

	// Determines whether to allow the domains that are supplied in the `allowed_domains` field to contain access control
	// list (ACL) templates.
	AllowedDomainsTemplate *bool `json:"allowed_domains_template,omitempty"`

	// Determines whether to allow clients to request private certificates that match the value of the actual domains on
	// the final certificate.
	//
	// For example, if you specify `example.com` in the `allowed_domains` field, you grant clients the ability to request a
	// certificate that contains the name `example.com` as one of the DNS values on the final certificate.
	//
	// **Important:** In some scenarios, allowing bare domains can be considered a security risk.
	AllowBareDomains *bool `json:"allow_bare_domains,omitempty"`

	// Determines whether to allow clients to request private certificates with common names (CN) that are subdomains of
	// the CNs that are allowed by the other certificate template options. This includes wildcard subdomains.
	//
	// For example, if `allowed_domains` has a value of `example.com` and `allow_subdomains`is set to `true`, then the
	// following subdomains are allowed: `foo.example.com`, `bar.example.com`, `*.example.com`.
	//
	// **Note:** This field is redundant if you use the `allow_any_name` option.
	AllowSubdomains *bool `json:"allow_subdomains,omitempty"`

	// Determines whether to allow glob patterns, for example, `ftp*.example.com`, in the names that are specified in the
	// `allowed_domains` field.
	//
	// If set to `true`, clients are allowed to request private certificates with names that match the glob patterns.
	AllowGlobDomains *bool `json:"allow_glob_domains,omitempty"`

	// Determines whether to allow clients to request a private certificate that matches any common name.
	AllowAnyName *bool `json:"allow_any_name,omitempty"`

	// Determines whether to enforce only valid host names for common names, DNS Subject Alternative Names, and the host
	// section of email addresses.
	EnforceHostnames *bool `json:"enforce_hostnames,omitempty"`

	// Determines whether to allow clients to request a private certificate with IP Subject Alternative Names.
	AllowIPSans *bool `json:"allow_ip_sans,omitempty"`

	// The URI Subject Alternative Names to allow for private certificates.
	//
	// Values can contain glob patterns, for example `spiffe://hostname/_*`.
	AllowedURISans []string `json:"allowed_uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names (SANs) to allow for private
	// certificates.
	//
	// The format for each element in the list is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type
	// is `UTF8`. To allow any value for an OID, use `*` as its value. Alternatively, specify a single `*` to allow any
	// `other_sans` input.
	AllowedOtherSans []string `json:"allowed_other_sans,omitempty"`

	// Determines whether private certificates are flagged for server use.
	ServerFlag *bool `json:"server_flag,omitempty"`

	// Determines whether private certificates are flagged for client use.
	ClientFlag *bool `json:"client_flag,omitempty"`

	// Determines whether private certificates are flagged for code signing use.
	CodeSigningFlag *bool `json:"code_signing_flag,omitempty"`

	// Determines whether private certificates are flagged for email protection use.
	EmailProtectionFlag *bool `json:"email_protection_flag,omitempty"`

	// The allowed key usage constraint to define for private certificates.
	//
	// You can find valid values in the [Go x509 package documentation](https://pkg.go.dev/crypto/x509#KeyUsage).  Omit the
	// `KeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to
	// an empty list.
	KeyUsage []string `json:"key_usage,omitempty"`

	// The allowed extended key usage constraint on private certificates.
	//
	// You can find valid values in the [Go x509 package documentation](https://golang.org/pkg/crypto/x509/#ExtKeyUsage).
	// Omit the `ExtKeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set
	// this field to an empty list.
	ExtKeyUsage []string `json:"ext_key_usage,omitempty"`

	// A list of extended key usage Object Identifiers (OIDs).
	ExtKeyUsageOids []string `json:"ext_key_usage_oids,omitempty"`

	// When used with the `sign_csr` action, this field determines whether to use the common name (CN) from a certificate
	// signing request (CSR) instead of the CN that's included in the JSON data of the certificate.
	//
	// Does not include any requested Subject Alternative Names (SANs) in the CSR. To use the alternative names, include
	// the `use_csr_sans` property.
	UseCsrCommonName *bool `json:"use_csr_common_name,omitempty"`

	// When used with the `sign_csr` action, this field determines whether to use the Subject Alternative Names
	// (SANs) from a certificate signing request (CSR) instead of the SANs that are included in the JSON data of the
	// certificate.
	//
	// Does not include the common name in the CSR. To use the common name, include the `use_csr_common_name` property.
	UseCsrSans *bool `json:"use_csr_sans,omitempty"`

	// Determines whether to require a common name to create a private certificate.
	//
	// By default, a common name is required to generate a certificate. To make the `common_name` field optional, set the
	// `require_cn` option to `false`.
	RequireCn *bool `json:"require_cn,omitempty"`

	// A list of policy Object Identifiers (OIDs).
	PolicyIdentifiers []string `json:"policy_identifiers,omitempty"`

	// Determines whether to mark the Basic Constraints extension of an issued private certificate as valid for non-CA
	// certificates.
	BasicConstraintsValidForNonCa *bool `json:"basic_constraints_valid_for_non_ca,omitempty"`

	// The duration in seconds by which to backdate the `not_before` property of an issued private certificate.
	//
	// The value can be supplied as a string representation of a duration, such as `30s`. In the API response, this value
	// is returned in seconds (integer).
	NotBeforeDuration interface{} `json:"not_before_duration,omitempty"`
}

ConfigElementDefConfig : The configuration to define for the specified secret type. Models which "extend" this model: - ConfigElementDefConfigLetsEncryptConfig - ConfigElementDefConfigCloudInternetServicesConfig - ConfigElementDefConfigClassicInfrastructureConfig - RootCertificateAuthorityConfig - IntermediateCertificateAuthorityConfig - CertificateTemplateConfig

type ConfigElementDefConfigClassicInfrastructureConfig added in v1.0.25

type ConfigElementDefConfigClassicInfrastructureConfig struct {
	// The username that is associated with your classic infrastructure account.
	//
	// In most cases, your classic infrastructure username is your `<account_id>_<email_address>`. For more information,
	// see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).
	ClassicInfrastructureUsername *string `json:"classic_infrastructure_username" validate:"required"`

	// Your classic infrastructure API key.
	//
	// For information about viewing and accessing your classic infrastructure API key, see the
	// [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).
	ClassicInfrastructurePassword *string `json:"classic_infrastructure_password" validate:"required"`
}

ConfigElementDefConfigClassicInfrastructureConfig : Properties that describe an IBM Cloud classic infrastructure (SoftLayer) configuration. This model "extends" ConfigElementDefConfig

type ConfigElementDefConfigCloudInternetServicesConfig added in v1.0.25

type ConfigElementDefConfigCloudInternetServicesConfig struct {
	// The Cloud Resource Name (CRN) that is associated with the CIS instance.
	CisCRN *string `json:"cis_crn" validate:"required"`

	// An IBM Cloud API key that can to list domains in your CIS instance.
	//
	// To grant Secrets Manager the ability to view the CIS instance and all of its domains, the API key must be assigned
	// the Reader service role on Internet Services (`internet-svcs`).
	//
	// If you need to manage specific domains, you can assign the Manager role. For production environments, it is
	// recommended that you assign the Reader access role, and then use the
	// [IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy) to control specific
	// domains. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-specific-domains).
	CisApikey *string `json:"cis_apikey,omitempty"`
}

ConfigElementDefConfigCloudInternetServicesConfig : Properties that describe an IBM Cloud Internet Services (CIS) configuration. This model "extends" ConfigElementDefConfig

type ConfigElementDefConfigIntf added in v1.0.25

type ConfigElementDefConfigIntf interface {
	// contains filtered or unexported methods
}

type ConfigElementDefConfigLetsEncryptConfig added in v1.0.25

type ConfigElementDefConfigLetsEncryptConfig struct {
	// The private key that is associated with your Automatic Certificate Management Environment (ACME) account.
	//
	// If you have a working ACME client or account for Let's Encrypt, you can use the existing private key to enable
	// communications with Secrets Manager. If you don't have an account yet, you can create one. For more information, see
	// the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#create-acme-account).
	PrivateKey *string `json:"private_key" validate:"required"`
}

ConfigElementDefConfigLetsEncryptConfig : Properties that describe a Let's Encrypt configuration. This model "extends" ConfigElementDefConfig

type ConfigElementMetadata added in v1.0.25

type ConfigElementMetadata struct {
	// The human-readable name to assign to your configuration.
	Name *string `json:"name" validate:"required"`

	// The type of configuration. Value options differ depending on the `config_element` property that you want to define.
	Type *string `json:"type" validate:"required"`
}

ConfigElementMetadata : Properties that describe a configuration element.

type CreateConfigElementOptions added in v1.0.25

type CreateConfigElementOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

	// The human-readable name to assign to your configuration.
	Name *string `json:"name" validate:"required"`

	// The type of configuration. Value options differ depending on the `config_element` property that you want to define.
	Type *string `json:"type" validate:"required"`

	// The configuration to define for the specified secret type.
	Config ConfigElementDefConfigIntf `json:"config" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateConfigElementOptions : The CreateConfigElement options.

func (*CreateConfigElementOptions) SetConfig added in v1.0.25

SetConfig : Allow user to set Config

func (*CreateConfigElementOptions) SetConfigElement added in v1.0.25

func (_options *CreateConfigElementOptions) SetConfigElement(configElement string) *CreateConfigElementOptions

SetConfigElement : Allow user to set ConfigElement

func (*CreateConfigElementOptions) SetHeaders added in v1.0.25

func (options *CreateConfigElementOptions) SetHeaders(param map[string]string) *CreateConfigElementOptions

SetHeaders : Allow user to set Headers

func (*CreateConfigElementOptions) SetName added in v1.0.25

SetName : Allow user to set Name

func (*CreateConfigElementOptions) SetSecretType added in v1.0.25

func (_options *CreateConfigElementOptions) SetSecretType(secretType string) *CreateConfigElementOptions

SetSecretType : Allow user to set SecretType

func (*CreateConfigElementOptions) SetType added in v1.0.25

func (_options *CreateConfigElementOptions) SetType(typeVar string) *CreateConfigElementOptions

SetType : Allow user to set Type

type CreateIamCredentialsSecretEngineRootConfig added in v1.0.27

type CreateIamCredentialsSecretEngineRootConfig struct {
	// An IBM Cloud API key that can create and manage service IDs.
	//
	// The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on
	// the IAM Identity Service. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
	APIKey *string `json:"api_key" validate:"required"`

	// The hash value of the IBM Cloud API key that is used to create and manage service IDs.
	APIKeyHash *string `json:"api_key_hash,omitempty"`
}

CreateIamCredentialsSecretEngineRootConfig : Configuration for the IAM credentials engine. This model "extends" EngineConfig

type CreateNotificationsRegistrationOptions added in v1.0.28

type CreateNotificationsRegistrationOptions struct {
	// The Cloud Resource Name (CRN) of the connected Event Notifications instance.
	EventNotificationsInstanceCRN *string `json:"event_notifications_instance_crn" validate:"required"`

	// The name that is displayed as a source in your Event Notifications instance.
	EventNotificationsSourceName *string `json:"event_notifications_source_name" validate:"required"`

	// An optional description for the source in your Event Notifications instance.
	EventNotificationsSourceDescription *string `json:"event_notifications_source_description,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateNotificationsRegistrationOptions : The CreateNotificationsRegistration options.

func (*CreateNotificationsRegistrationOptions) SetEventNotificationsInstanceCRN added in v1.0.28

func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsInstanceCRN(eventNotificationsInstanceCRN string) *CreateNotificationsRegistrationOptions

SetEventNotificationsInstanceCRN : Allow user to set EventNotificationsInstanceCRN

func (*CreateNotificationsRegistrationOptions) SetEventNotificationsSourceDescription added in v1.0.28

func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsSourceDescription(eventNotificationsSourceDescription string) *CreateNotificationsRegistrationOptions

SetEventNotificationsSourceDescription : Allow user to set EventNotificationsSourceDescription

func (*CreateNotificationsRegistrationOptions) SetEventNotificationsSourceName added in v1.0.28

func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsSourceName(eventNotificationsSourceName string) *CreateNotificationsRegistrationOptions

SetEventNotificationsSourceName : Allow user to set EventNotificationsSourceName

func (*CreateNotificationsRegistrationOptions) SetHeaders added in v1.0.28

SetHeaders : Allow user to set Headers

type CreateSecret

type CreateSecret struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretResourceIntf `json:"resources" validate:"required"`
}

CreateSecret : Properties that describe a secret.

type CreateSecretGroupOptions

type CreateSecretGroupOptions struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretGroupResource `json:"resources" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateSecretGroupOptions : The CreateSecretGroup options.

func (*CreateSecretGroupOptions) SetHeaders

func (options *CreateSecretGroupOptions) SetHeaders(param map[string]string) *CreateSecretGroupOptions

SetHeaders : Allow user to set Headers

func (*CreateSecretGroupOptions) SetMetadata

func (_options *CreateSecretGroupOptions) SetMetadata(metadata *CollectionMetadata) *CreateSecretGroupOptions

SetMetadata : Allow user to set Metadata

func (*CreateSecretGroupOptions) SetResources

func (_options *CreateSecretGroupOptions) SetResources(resources []SecretGroupResource) *CreateSecretGroupOptions

SetResources : Allow user to set Resources

type CreateSecretOptions

type CreateSecretOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretResourceIntf `json:"resources" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateSecretOptions : The CreateSecret options.

func (*CreateSecretOptions) SetHeaders

func (options *CreateSecretOptions) SetHeaders(param map[string]string) *CreateSecretOptions

SetHeaders : Allow user to set Headers

func (*CreateSecretOptions) SetMetadata

func (_options *CreateSecretOptions) SetMetadata(metadata *CollectionMetadata) *CreateSecretOptions

SetMetadata : Allow user to set Metadata

func (*CreateSecretOptions) SetResources

func (_options *CreateSecretOptions) SetResources(resources []SecretResourceIntf) *CreateSecretOptions

SetResources : Allow user to set Resources

func (*CreateSecretOptions) SetSecretType

func (_options *CreateSecretOptions) SetSecretType(secretType string) *CreateSecretOptions

SetSecretType : Allow user to set SecretType

type DeleteConfigElementOptions added in v1.0.25

type DeleteConfigElementOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

	// The name of your configuration.
	ConfigName *string `json:"config_name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteConfigElementOptions : The DeleteConfigElement options.

func (*DeleteConfigElementOptions) SetConfigElement added in v1.0.25

func (_options *DeleteConfigElementOptions) SetConfigElement(configElement string) *DeleteConfigElementOptions

SetConfigElement : Allow user to set ConfigElement

func (*DeleteConfigElementOptions) SetConfigName added in v1.0.25

func (_options *DeleteConfigElementOptions) SetConfigName(configName string) *DeleteConfigElementOptions

SetConfigName : Allow user to set ConfigName

func (*DeleteConfigElementOptions) SetHeaders added in v1.0.25

func (options *DeleteConfigElementOptions) SetHeaders(param map[string]string) *DeleteConfigElementOptions

SetHeaders : Allow user to set Headers

func (*DeleteConfigElementOptions) SetSecretType added in v1.0.25

func (_options *DeleteConfigElementOptions) SetSecretType(secretType string) *DeleteConfigElementOptions

SetSecretType : Allow user to set SecretType

type DeleteCredentialsForIamCredentialsSecret added in v1.0.22

type DeleteCredentialsForIamCredentialsSecret struct {
	// The ID of the API key that you want to delete. If the secret was created with a static service ID, only the API key
	// is deleted. Otherwise, the service ID is deleted together with its API key.
	APIKeyID *string `json:"api_key_id,omitempty"`

	// The service ID that you want to delete. This property can be used instead of the `api_key_id` field, but only for
	// secrets that were created with a service ID that was generated by Secrets Manager.
	//
	// **Deprecated.** Use the `api_key_id` field instead.
	// Deprecated: this field is deprecated and may be removed in a future release.
	ServiceID *string `json:"service_id,omitempty"`
}

DeleteCredentialsForIamCredentialsSecret : Delete the credentials that are associated with an `iam_credentials` secret. This model "extends" SecretAction

type DeleteNotificationsRegistrationOptions added in v1.0.28

type DeleteNotificationsRegistrationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteNotificationsRegistrationOptions : The DeleteNotificationsRegistration options.

func (*DeleteNotificationsRegistrationOptions) SetHeaders added in v1.0.28

SetHeaders : Allow user to set Headers

type DeleteSecretGroupOptions

type DeleteSecretGroupOptions struct {
	// The v4 UUID that uniquely identifies the secret group.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteSecretGroupOptions : The DeleteSecretGroup options.

func (*DeleteSecretGroupOptions) SetHeaders

func (options *DeleteSecretGroupOptions) SetHeaders(param map[string]string) *DeleteSecretGroupOptions

SetHeaders : Allow user to set Headers

func (*DeleteSecretGroupOptions) SetID

SetID : Allow user to set ID

type DeleteSecretOptions

type DeleteSecretOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteSecretOptions : The DeleteSecret options.

func (*DeleteSecretOptions) SetHeaders

func (options *DeleteSecretOptions) SetHeaders(param map[string]string) *DeleteSecretOptions

SetHeaders : Allow user to set Headers

func (*DeleteSecretOptions) SetID

func (_options *DeleteSecretOptions) SetID(id string) *DeleteSecretOptions

SetID : Allow user to set ID

func (*DeleteSecretOptions) SetSecretType

func (_options *DeleteSecretOptions) SetSecretType(secretType string) *DeleteSecretOptions

SetSecretType : Allow user to set SecretType

type EngineConfig added in v1.0.22

type EngineConfig struct {
	// An IBM Cloud API key that can create and manage service IDs.
	//
	// The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on
	// the IAM Identity Service. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
	APIKey *string `json:"api_key,omitempty"`

	// The hash value of the IBM Cloud API key that is used to create and manage service IDs.
	APIKeyHash *string `json:"api_key_hash,omitempty"`
}

EngineConfig : EngineConfig struct Models which "extend" this model: - CreateIamCredentialsSecretEngineRootConfig

type EngineConfigIntf added in v1.0.22

type EngineConfigIntf interface {
	// contains filtered or unexported methods
}

type GetConfig added in v0.1.20

type GetConfig struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []GetConfigResourcesItemIntf `json:"resources" validate:"required"`
}

GetConfig : Configuration for the specified secret type.

type GetConfigElementOptions added in v1.0.25

type GetConfigElementOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

	// The name of your configuration.
	ConfigName *string `json:"config_name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetConfigElementOptions : The GetConfigElement options.

func (*GetConfigElementOptions) SetConfigElement added in v1.0.25

func (_options *GetConfigElementOptions) SetConfigElement(configElement string) *GetConfigElementOptions

SetConfigElement : Allow user to set ConfigElement

func (*GetConfigElementOptions) SetConfigName added in v1.0.25

func (_options *GetConfigElementOptions) SetConfigName(configName string) *GetConfigElementOptions

SetConfigName : Allow user to set ConfigName

func (*GetConfigElementOptions) SetHeaders added in v1.0.25

func (options *GetConfigElementOptions) SetHeaders(param map[string]string) *GetConfigElementOptions

SetHeaders : Allow user to set Headers

func (*GetConfigElementOptions) SetSecretType added in v1.0.25

func (_options *GetConfigElementOptions) SetSecretType(secretType string) *GetConfigElementOptions

SetSecretType : Allow user to set SecretType

type GetConfigElements added in v1.0.25

type GetConfigElements struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []GetConfigElementsResourcesItemIntf `json:"resources" validate:"required"`
}

GetConfigElements : Properties that describe a list of configurations.

type GetConfigElementsOptions added in v1.0.25

type GetConfigElementsOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetConfigElementsOptions : The GetConfigElements options.

func (*GetConfigElementsOptions) SetConfigElement added in v1.0.25

func (_options *GetConfigElementsOptions) SetConfigElement(configElement string) *GetConfigElementsOptions

SetConfigElement : Allow user to set ConfigElement

func (*GetConfigElementsOptions) SetHeaders added in v1.0.25

func (options *GetConfigElementsOptions) SetHeaders(param map[string]string) *GetConfigElementsOptions

SetHeaders : Allow user to set Headers

func (*GetConfigElementsOptions) SetSecretType added in v1.0.25

func (_options *GetConfigElementsOptions) SetSecretType(secretType string) *GetConfigElementsOptions

SetSecretType : Allow user to set SecretType

type GetConfigElementsResourcesItem added in v1.0.25

type GetConfigElementsResourcesItem struct {
	CertificateAuthorities []ConfigElementMetadata `json:"certificate_authorities,omitempty"`

	DNSProviders []ConfigElementMetadata `json:"dns_providers,omitempty"`

	RootCertificateAuthorities []RootCertificateAuthoritiesConfigItem `json:"root_certificate_authorities,omitempty"`

	IntermediateCertificateAuthorities []IntermediateCertificateAuthoritiesConfigItem `json:"intermediate_certificate_authorities,omitempty"`

	CertificateTemplates []CertificateTemplatesConfigItem `json:"certificate_templates,omitempty"`
}

GetConfigElementsResourcesItem : GetConfigElementsResourcesItem struct Models which "extend" this model: - GetConfigElementsResourcesItemCertificateAuthoritiesConfig - GetConfigElementsResourcesItemDNSProvidersConfig - RootCertificateAuthoritiesConfig - IntermediateCertificateAuthoritiesConfig - CertificateTemplatesConfig

type GetConfigElementsResourcesItemCertificateAuthoritiesConfig added in v1.0.25

type GetConfigElementsResourcesItemCertificateAuthoritiesConfig struct {
	CertificateAuthorities []ConfigElementMetadata `json:"certificate_authorities" validate:"required"`
}

GetConfigElementsResourcesItemCertificateAuthoritiesConfig : Certificate authorities configuration. This model "extends" GetConfigElementsResourcesItem

type GetConfigElementsResourcesItemDNSProvidersConfig added in v1.0.25

type GetConfigElementsResourcesItemDNSProvidersConfig struct {
	DNSProviders []ConfigElementMetadata `json:"dns_providers" validate:"required"`
}

GetConfigElementsResourcesItemDNSProvidersConfig : DNS providers configuration. This model "extends" GetConfigElementsResourcesItem

type GetConfigElementsResourcesItemIntf added in v1.0.25

type GetConfigElementsResourcesItemIntf interface {
	// contains filtered or unexported methods
}

type GetConfigOptions

type GetConfigOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetConfigOptions : The GetConfig options.

func (*GetConfigOptions) SetHeaders

func (options *GetConfigOptions) SetHeaders(param map[string]string) *GetConfigOptions

SetHeaders : Allow user to set Headers

func (*GetConfigOptions) SetSecretType

func (_options *GetConfigOptions) SetSecretType(secretType string) *GetConfigOptions

SetSecretType : Allow user to set SecretType

type GetConfigResourcesItem added in v1.0.25

type GetConfigResourcesItem struct {
	// The certificate authority configurations that are associated with your instance.
	CertificateAuthorities []ConfigElementMetadata `json:"certificate_authorities,omitempty"`

	// The DNS provider configurations that are associated with your instance.
	DNSProviders []ConfigElementMetadata `json:"dns_providers,omitempty"`

	// The root certificate authority configurations that are associated with your instance.
	RootCertificateAuthorities []RootCertificateAuthoritiesConfigItem `json:"root_certificate_authorities,omitempty"`

	// The intermediate certificate authority configurations that are associated with your instance.
	IntermediateCertificateAuthorities []IntermediateCertificateAuthoritiesConfigItem `json:"intermediate_certificate_authorities,omitempty"`

	// The certificate templates that are associated with your instance.
	CertificateTemplates []CertificateTemplatesConfigItem `json:"certificate_templates,omitempty"`

	// An IBM Cloud API key that can create and manage service IDs.
	//
	// The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on
	// the IAM Identity Service. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
	APIKey *string `json:"api_key,omitempty"`

	// The hash value of the IBM Cloud API key that is used to create and manage service IDs.
	APIKeyHash *string `json:"api_key_hash,omitempty"`
}

GetConfigResourcesItem : GetConfigResourcesItem struct Models which "extend" this model: - PublicCertSecretEngineRootConfig - PrivateCertSecretEngineRootConfig - IamCredentialsSecretEngineRootConfig

type GetConfigResourcesItemIntf added in v1.0.25

type GetConfigResourcesItemIntf interface {
	// contains filtered or unexported methods
}

type GetInstanceLocks added in v1.0.45

type GetInstanceLocks struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []InstanceSecretsLocks `json:"resources" validate:"required"`
}

GetInstanceLocks : Properties that describe the locks that are associated with an instance.

type GetLocksOptions added in v1.0.45

type GetLocksOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The number of locks to retrieve. By default, list operations return the first 25 items. To retrieve a different set
	// of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 locks associated with your secret, and you want to retrieve only the first 5 locks, use
	// `..?limit=5`.
	Limit *int64 `json:"limit,omitempty"`

	// The number of locks to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`
	// value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 locks on your secret, and you want to retrieve locks 26 through 50, use
	// `..?offset=25&limit=25`.
	Offset *int64 `json:"offset,omitempty"`

	// Filter locks that contain the specified string in the field "name".
	//
	// **Usage:** If you want to list only the locks that contain the string "text" in the field "name", use
	// `..?search=text`.
	Search *string `json:"search,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetLocksOptions : The GetLocks options.

func (*GetLocksOptions) SetHeaders added in v1.0.45

func (options *GetLocksOptions) SetHeaders(param map[string]string) *GetLocksOptions

SetHeaders : Allow user to set Headers

func (*GetLocksOptions) SetID added in v1.0.45

func (_options *GetLocksOptions) SetID(id string) *GetLocksOptions

SetID : Allow user to set ID

func (*GetLocksOptions) SetLimit added in v1.0.45

func (_options *GetLocksOptions) SetLimit(limit int64) *GetLocksOptions

SetLimit : Allow user to set Limit

func (*GetLocksOptions) SetOffset added in v1.0.45

func (_options *GetLocksOptions) SetOffset(offset int64) *GetLocksOptions

SetOffset : Allow user to set Offset

func (*GetLocksOptions) SetSearch added in v1.0.45

func (_options *GetLocksOptions) SetSearch(search string) *GetLocksOptions

SetSearch : Allow user to set Search

func (*GetLocksOptions) SetSecretType added in v1.0.45

func (_options *GetLocksOptions) SetSecretType(secretType string) *GetLocksOptions

SetSecretType : Allow user to set SecretType

type GetNotificationsRegistrationOptions added in v1.0.28

type GetNotificationsRegistrationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetNotificationsRegistrationOptions : The GetNotificationsRegistration options.

func (*GetNotificationsRegistrationOptions) SetHeaders added in v1.0.28

SetHeaders : Allow user to set Headers

type GetNotificationsSettings added in v1.0.28

type GetNotificationsSettings struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []NotificationsSettings `json:"resources" validate:"required"`
}

GetNotificationsSettings : Properties that describe an existing registration with Event Notifications.

type GetPolicyOptions

type GetPolicyOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The type of policy that is associated with the specified secret.
	Policy *string `json:"policy,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetPolicyOptions : The GetPolicy options.

func (*GetPolicyOptions) SetHeaders

func (options *GetPolicyOptions) SetHeaders(param map[string]string) *GetPolicyOptions

SetHeaders : Allow user to set Headers

func (*GetPolicyOptions) SetID

func (_options *GetPolicyOptions) SetID(id string) *GetPolicyOptions

SetID : Allow user to set ID

func (*GetPolicyOptions) SetPolicy

func (_options *GetPolicyOptions) SetPolicy(policy string) *GetPolicyOptions

SetPolicy : Allow user to set Policy

func (*GetPolicyOptions) SetSecretType

func (_options *GetPolicyOptions) SetSecretType(secretType string) *GetPolicyOptions

SetSecretType : Allow user to set SecretType

type GetSecret

type GetSecret struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretResourceIntf `json:"resources" validate:"required"`
}

GetSecret : Properties that describe a secret.

type GetSecretGroupOptions

type GetSecretGroupOptions struct {
	// The v4 UUID that uniquely identifies the secret group.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSecretGroupOptions : The GetSecretGroup options.

func (*GetSecretGroupOptions) SetHeaders

func (options *GetSecretGroupOptions) SetHeaders(param map[string]string) *GetSecretGroupOptions

SetHeaders : Allow user to set Headers

func (*GetSecretGroupOptions) SetID

func (_options *GetSecretGroupOptions) SetID(id string) *GetSecretGroupOptions

SetID : Allow user to set ID

type GetSecretLocks added in v1.0.45

type GetSecretLocks struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretsLocks `json:"resources" validate:"required"`
}

GetSecretLocks : Properties that describe the lock of a secret or a secret version.

type GetSecretMetadataOptions

type GetSecretMetadataOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSecretMetadataOptions : The GetSecretMetadata options.

func (*GetSecretMetadataOptions) SetHeaders

func (options *GetSecretMetadataOptions) SetHeaders(param map[string]string) *GetSecretMetadataOptions

SetHeaders : Allow user to set Headers

func (*GetSecretMetadataOptions) SetID

SetID : Allow user to set ID

func (*GetSecretMetadataOptions) SetSecretType

func (_options *GetSecretMetadataOptions) SetSecretType(secretType string) *GetSecretMetadataOptions

SetSecretType : Allow user to set SecretType

type GetSecretOptions

type GetSecretOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSecretOptions : The GetSecret options.

func (*GetSecretOptions) SetHeaders

func (options *GetSecretOptions) SetHeaders(param map[string]string) *GetSecretOptions

SetHeaders : Allow user to set Headers

func (*GetSecretOptions) SetID

func (_options *GetSecretOptions) SetID(id string) *GetSecretOptions

SetID : Allow user to set ID

func (*GetSecretOptions) SetSecretType

func (_options *GetSecretOptions) SetSecretType(secretType string) *GetSecretOptions

SetSecretType : Allow user to set SecretType

type GetSecretPolicies added in v1.0.22

type GetSecretPolicies struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata,omitempty"`

	// A collection of resources.
	Resources []map[string]interface{} `json:"resources,omitempty"`
}

GetSecretPolicies : GetSecretPolicies struct Models which "extend" this model: - GetSecretPolicyRotation

type GetSecretPoliciesIntf added in v1.0.22

type GetSecretPoliciesIntf interface {
	// contains filtered or unexported methods
}

type GetSecretPolicyRotation added in v1.0.22

type GetSecretPolicyRotation struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []map[string]interface{} `json:"resources" validate:"required"`
}

GetSecretPolicyRotation : Properties that describe a rotation policy. This model "extends" GetSecretPolicies

type GetSecretVersion added in v1.0.22

type GetSecretVersion struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretVersionIntf `json:"resources" validate:"required"`
}

GetSecretVersion : Properties that describe the version of a secret.

type GetSecretVersionLocksOptions added in v1.0.45

type GetSecretVersionLocksOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

	// The number of locks to retrieve. By default, list operations return the first 25 items. To retrieve a different set
	// of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 locks associated with your secret, and you want to retrieve only the first 5 locks, use
	// `..?limit=5`.
	Limit *int64 `json:"limit,omitempty"`

	// The number of locks to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`
	// value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 locks on your secret, and you want to retrieve locks 26 through 50, use
	// `..?offset=25&limit=25`.
	Offset *int64 `json:"offset,omitempty"`

	// Filter locks that contain the specified string in the field "name".
	//
	// **Usage:** If you want to list only the locks that contain the string "text" in the field "name", use
	// `..?search=text`.
	Search *string `json:"search,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSecretVersionLocksOptions : The GetSecretVersionLocks options.

func (*GetSecretVersionLocksOptions) SetHeaders added in v1.0.45

SetHeaders : Allow user to set Headers

func (*GetSecretVersionLocksOptions) SetID added in v1.0.45

SetID : Allow user to set ID

func (*GetSecretVersionLocksOptions) SetLimit added in v1.0.45

SetLimit : Allow user to set Limit

func (*GetSecretVersionLocksOptions) SetOffset added in v1.0.45

SetOffset : Allow user to set Offset

func (*GetSecretVersionLocksOptions) SetSearch added in v1.0.45

SetSearch : Allow user to set Search

func (*GetSecretVersionLocksOptions) SetSecretType added in v1.0.45

func (_options *GetSecretVersionLocksOptions) SetSecretType(secretType string) *GetSecretVersionLocksOptions

SetSecretType : Allow user to set SecretType

func (*GetSecretVersionLocksOptions) SetVersionID added in v1.0.45

func (_options *GetSecretVersionLocksOptions) SetVersionID(versionID string) *GetSecretVersionLocksOptions

SetVersionID : Allow user to set VersionID

type GetSecretVersionMetadata added in v1.0.22

type GetSecretVersionMetadata struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretVersionMetadataIntf `json:"resources" validate:"required"`
}

GetSecretVersionMetadata : Properties that describe the version of a secret.

type GetSecretVersionMetadataOptions added in v1.0.22

type GetSecretVersionMetadataOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSecretVersionMetadataOptions : The GetSecretVersionMetadata options.

func (*GetSecretVersionMetadataOptions) SetHeaders added in v1.0.22

SetHeaders : Allow user to set Headers

func (*GetSecretVersionMetadataOptions) SetID added in v1.0.22

SetID : Allow user to set ID

func (*GetSecretVersionMetadataOptions) SetSecretType added in v1.0.22

func (_options *GetSecretVersionMetadataOptions) SetSecretType(secretType string) *GetSecretVersionMetadataOptions

SetSecretType : Allow user to set SecretType

func (*GetSecretVersionMetadataOptions) SetVersionID added in v1.0.22

func (_options *GetSecretVersionMetadataOptions) SetVersionID(versionID string) *GetSecretVersionMetadataOptions

SetVersionID : Allow user to set VersionID

type GetSecretVersionOptions added in v1.0.22

type GetSecretVersionOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSecretVersionOptions : The GetSecretVersion options.

func (*GetSecretVersionOptions) SetHeaders added in v1.0.22

func (options *GetSecretVersionOptions) SetHeaders(param map[string]string) *GetSecretVersionOptions

SetHeaders : Allow user to set Headers

func (*GetSecretVersionOptions) SetID added in v1.0.22

SetID : Allow user to set ID

func (*GetSecretVersionOptions) SetSecretType added in v1.0.22

func (_options *GetSecretVersionOptions) SetSecretType(secretType string) *GetSecretVersionOptions

SetSecretType : Allow user to set SecretType

func (*GetSecretVersionOptions) SetVersionID added in v1.0.22

func (_options *GetSecretVersionOptions) SetVersionID(versionID string) *GetSecretVersionOptions

SetVersionID : Allow user to set VersionID

type GetSingleConfigElement added in v1.0.25

type GetSingleConfigElement struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []ConfigElementDef `json:"resources" validate:"required"`
}

GetSingleConfigElement : Properties that describe a configuration.

type IamCredentialsSecretEngineRootConfig added in v1.0.22

type IamCredentialsSecretEngineRootConfig struct {
	// An IBM Cloud API key that can create and manage service IDs.
	//
	// The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on
	// the IAM Identity Service. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
	APIKey *string `json:"api_key" validate:"required"`

	// The hash value of the IBM Cloud API key that is used to create and manage service IDs.
	APIKeyHash *string `json:"api_key_hash,omitempty"`
}

IamCredentialsSecretEngineRootConfig : Configuration for the IAM credentials engine. This model "extends" GetConfigResourcesItem

type IamCredentialsSecretMetadata added in v1.0.22

type IamCredentialsSecretMetadata struct {
	// The unique ID of the secret.
	ID *string `json:"id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be in the range 2 - 30 characters, including spaces. Special characters
	// that are not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies the resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when any part of the secret metadata is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The time-to-live (TTL) or lease duration that is assigned to the secret. For `iam_credentials` secrets, the TTL
	// defines for how long each generated API key remains valid.
	TTL *string `json:"ttl,omitempty"`

	// Determines whether to use the same service ID and API key for future read operations on an
	// `iam_credentials` secret.
	//
	// If set to `true`, the service reuses the current credentials. If set to `false`, a new service ID and API key are
	// generated each time that the secret is read or accessed.
	ReuseAPIKey *bool `json:"reuse_api_key,omitempty"`

	// Indicates whether an `iam_credentials` secret was created with a static service ID.
	//
	// If the value is `true`, the service ID for the secret was provided by the user at secret creation. If the value is
	// `false`, the service ID was generated by Secrets Manager.
	ServiceIDIsStatic *bool `json:"service_id_is_static,omitempty"`

	// The service ID under which the API key is created. The service ID is included in the metadata only if the secret was
	// created with a static service ID.
	ServiceID *string `json:"service_id,omitempty"`

	// The access groups that define the capabilities of the service ID and API key that are generated for an
	// `iam_credentials` secret. The access groups are included in the metadata only if the secret was created with a
	// service ID that was generated by Secrets Manager.
	AccessGroups []string `json:"access_groups,omitempty"`
}

IamCredentialsSecretMetadata : Metadata properties that describe an `iam_credentials` secret. This model "extends" SecretMetadata

type IamCredentialsSecretResource added in v1.0.22

type IamCredentialsSecretResource struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be 2 - 30 characters, including spaces. Special characters that are not
	// permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// An array that contains metadata for each secret version. For more information on the metadata properties, see [Get
	// secret version metadata](#get-secret-version-metadata).
	Versions []map[string]interface{} `json:"versions,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The time-to-live (TTL) or lease duration to assign to generated credentials.
	//
	// For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be
	// either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m`
	// or `24h`.
	//
	// Minimum duration is 1 minute. Maximum is 90 days.
	TTL interface{} `json:"ttl,omitempty"`

	// The access groups that define the capabilities of the service ID and API key that are generated for an
	// `iam_credentials` secret. If you prefer to use an existing service ID that is already assigned the access policies
	// that you require, you can omit this parameter and use the `service_id` field instead.
	//
	// **Tip:** To list the access groups that are available in an account, you can use the [IAM Access Groups
	// API](https://cloud.ibm.com/apidocs/iam-access-groups#list-access-groups). To find the ID of an access group in the
	// console, go to **Manage > Access (IAM) > Access groups**. Select the access group to inspect, and click **Details**
	// to view its ID.
	AccessGroups []string `json:"access_groups,omitempty"`

	// The API key that is generated for this secret.
	//
	// After the secret reaches the end of its lease (see the `ttl` field), the API key is deleted automatically. If you
	// want to continue to use the same API key for future read operations, see the `reuse_api_key` field.
	APIKey *string `json:"api_key,omitempty"`

	// The ID of the API key that is generated for this secret.
	APIKeyID *string `json:"api_key_id,omitempty"`

	// The service ID under which the API key (see the `api_key` field) is created.
	//
	// If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it
	// to the access groups that you assign.
	//
	// Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or
	// retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include
	// the `access_groups` parameter.
	ServiceID *string `json:"service_id,omitempty"`

	// Indicates whether an `iam_credentials` secret was created with a static service ID.
	//
	// If `true`, the service ID for the secret was provided by the user at secret creation. If `false`, the service ID was
	// generated by Secrets Manager.
	ServiceIDIsStatic *bool `json:"service_id_is_static,omitempty"`

	// Determines whether to use the same service ID and API key for future read operations on an
	// `iam_credentials` secret.
	//
	// If set to `true`, the service reuses the current credentials. If set to `false`, a new service ID and API key are
	// generated each time that the secret is read or accessed.
	ReuseAPIKey *bool `json:"reuse_api_key,omitempty"`

	// 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.
	NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
}

IamCredentialsSecretResource : Properties that describe a secret. This model "extends" SecretResource

type IamCredentialsSecretVersion added in v1.0.28

type IamCredentialsSecretVersion struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`

	// The data that is associated with the secret version. The data object contains the following fields:
	//
	// - `api_key`: The API key that is generated for this secret.
	// - `api_key_id`: The ID of the API key that is generated for this secret.
	// - `service_id`: The service ID under which the API key is created.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`
}

IamCredentialsSecretVersion : IamCredentialsSecretVersion struct This model "extends" SecretVersion

type IamCredentialsSecretVersionInfo added in v1.0.28

type IamCredentialsSecretVersionInfo struct {
	// The ID of the secret version.
	ID *string `json:"id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`
}

IamCredentialsSecretVersionInfo : IamCredentialsSecretVersionInfo struct This model "extends" SecretVersionInfo

type IamCredentialsSecretVersionMetadata added in v1.0.22

type IamCredentialsSecretVersionMetadata struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`
}

IamCredentialsSecretVersionMetadata : Properties that describe a secret version. This model "extends" SecretVersionMetadata

type InstanceSecretsLocks added in v1.0.45

type InstanceSecretsLocks struct {
	// The unique ID of the secret.
	SecretID *string `json:"secret_id,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// A collection of locks that are attached to a secret version.
	Versions []SecretLockVersion `json:"versions,omitempty"`
	// contains filtered or unexported fields
}

InstanceSecretsLocks : Properties that describe the locks that are associated with an instance.

func (*InstanceSecretsLocks) GetProperties added in v1.0.45

func (o *InstanceSecretsLocks) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of InstanceSecretsLocks

func (*InstanceSecretsLocks) GetProperty added in v1.0.45

func (o *InstanceSecretsLocks) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of InstanceSecretsLocks

func (*InstanceSecretsLocks) MarshalJSON added in v1.0.45

func (o *InstanceSecretsLocks) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of InstanceSecretsLocks

func (*InstanceSecretsLocks) SetProperties added in v1.0.45

func (o *InstanceSecretsLocks) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of InstanceSecretsLocks

func (*InstanceSecretsLocks) SetProperty added in v1.0.45

func (o *InstanceSecretsLocks) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of InstanceSecretsLocks

type IntermediateCertificateAuthoritiesConfig added in v1.0.39

type IntermediateCertificateAuthoritiesConfig struct {
	IntermediateCertificateAuthorities []IntermediateCertificateAuthoritiesConfigItem `json:"intermediate_certificate_authorities" validate:"required"`
}

IntermediateCertificateAuthoritiesConfig : Intermediate certificate authorities configuration. This model "extends" GetConfigElementsResourcesItem

type IntermediateCertificateAuthoritiesConfigItem added in v1.0.39

type IntermediateCertificateAuthoritiesConfigItem struct {
	// The human-readable name to assign to your configuration.
	Name *string `json:"name" validate:"required"`

	// The type of configuration. Value options differ depending on the `config_element` property that you want to define.
	Type *string `json:"type" validate:"required"`

	// Intermediate certificate authority configuration.
	Config *IntermediateCertificateAuthorityConfig `json:"config,omitempty"`
}

IntermediateCertificateAuthoritiesConfigItem : Intermediate certificate authorities configuration.

type IntermediateCertificateAuthorityConfig added in v1.0.39

type IntermediateCertificateAuthorityConfig struct {
	// The maximum time-to-live (TTL) for certificates that are created by this CA.
	//
	// The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
	// response, this value is returned in seconds (integer).
	//
	// Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).
	MaxTTL interface{} `json:"max_ttl" validate:"required"`

	// The signing method to use with this certificate authority to generate private certificates.
	//
	// You can choose between internal or externally signed options. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).
	SigningMethod *string `json:"signing_method" validate:"required"`

	// The certificate authority that signed and issued the certificate.
	//
	// If the certificate is signed internally, the `issuer` field is required and must match the name of a certificate
	// authority that is configured in the Secrets Manager service instance.
	Issuer *string `json:"issuer,omitempty"`

	// The time until the certificate revocation list (CRL) expires.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours.
	// In the API response, this value is returned in seconds (integer).
	//
	// **Note:** The CRL is rotated automatically before it expires.
	CrlExpiry interface{} `json:"crl_expiry,omitempty"`

	// Disables or enables certificate revocation list (CRL) building.
	//
	// If CRL building is disabled, a signed but zero-length CRL is returned when downloading the CRL. If CRL building is
	// enabled,  it will rebuild the CRL.
	CrlDisable *bool `json:"crl_disable,omitempty"`

	// Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are
	// issued by this certificate authority.
	CrlDistributionPointsEncoded *bool `json:"crl_distribution_points_encoded,omitempty"`

	// Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this
	// certificate authority.
	IssuingCertificatesUrlsEncoded *bool `json:"issuing_certificates_urls_encoded,omitempty"`

	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name" validate:"required"`

	// The status of the certificate authority. The status of a root certificate authority is either `configured` or
	// `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,
	// `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
	Status *string `json:"status,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The format of the generated private key.
	PrivateKeyFormat *string `json:"private_key_format,omitempty"`

	// The type of private key to generate.
	KeyType *string `json:"key_type,omitempty"`

	// The number of bits to use when generating the private key.
	//
	// Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and
	// `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.
	KeyBits *int64 `json:"key_bits,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The data that is associated with the intermediate certificate authority. The data object contains the
	//  following fields:
	//
	// - `csr`: The PEM-encoded certificate signing request.
	// - `private_key`: The private key.
	// - `private_key_type`: The type of private key, for example `rsa`.
	Data map[string]interface{} `json:"data,omitempty"`
}

IntermediateCertificateAuthorityConfig : Intermediate certificate authority configuration. This model "extends" ConfigElementDefConfig

type IssuanceInfo added in v1.0.25

type IssuanceInfo struct {
	// The date the certificate was ordered. The date format follows RFC 3339.
	OrderedOn *strfmt.DateTime `json:"ordered_on,omitempty"`

	// A code that identifies an issuance error.
	//
	// This field, along with `error_message`, is returned when Secrets Manager successfully processes your request, but a
	// certificate is unable to be issued by the certificate authority.
	ErrorCode *string `json:"error_code,omitempty"`

	// A human-readable message that provides details about the issuance error.
	ErrorMessage *string `json:"error_message,omitempty"`

	// Indicates whether the issued certificate is bundled with intermediate certificates.
	BundleCerts *bool `json:"bundle_certs,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// Indicates whether the issued certificate is configured with an automatic rotation policy.
	AutoRotated *bool `json:"auto_rotated,omitempty"`

	// The name that was assigned to the certificate authority configuration.
	Ca *string `json:"ca,omitempty"`

	// The name that was assigned to the DNS provider configuration.
	DNS *string `json:"dns,omitempty"`

	// The set of challenges, will be returned only when ordering public certificate using manual DNS configuration.
	Challenges []ChallengeResource `json:"challenges,omitempty"`

	// The date a user called "validate dns challenges" for "manual" DNS provider. The date format follows RFC 3339.
	DNSChallengeValidationTime *strfmt.DateTime `json:"dns_challenge_validation_time,omitempty"`
}

IssuanceInfo : Issuance information that is associated with your certificate.

type KvSecretMetadata added in v1.0.30

type KvSecretMetadata struct {
	// The unique ID of the secret.
	ID *string `json:"id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be in the range 2 - 30 characters, including spaces. Special characters
	// that are not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies the resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when any part of the secret metadata is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
}

KvSecretMetadata : Metadata properties that describe a key-value secret. This model "extends" SecretMetadata

type KvSecretResource added in v1.0.30

type KvSecretResource struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be 2 - 30 characters, including spaces. Special characters that are not
	// permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// An array that contains metadata for each secret version. For more information on the metadata properties, see [Get
	// secret version metadata](#get-secret-version-metadata).
	Versions []map[string]interface{} `json:"versions,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The date the secret material expires. The date format follows RFC 3339.
	//
	// You can set an expiration date on supported secret types at their creation. If you create a secret without
	// specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
	// following secret types:
	//
	// - `arbitrary`
	// - `username_password`.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The new secret data to assign to the secret.
	Payload map[string]interface{} `json:"payload,omitempty"`

	// The data that is associated with the secret version.
	//
	// The data object contains the field `payload`.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`
}

KvSecretResource : Properties that describe a secret. This model "extends" SecretResource

type ListAllSecretsOptions

type ListAllSecretsOptions struct {
	// The number of secrets to retrieve. By default, list operations return the first 200 items. To retrieve a different
	// set of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5 secrets, use
	// `../secrets/{secret_type}?limit=5`.
	Limit *int64 `json:"limit,omitempty"`

	// The number of secrets to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`
	// value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 secrets in your instance, and you want to retrieve secrets 26 through 50, use
	// `..?offset=25&limit=25`.
	Offset *int64 `json:"offset,omitempty"`

	// Filter secrets that contain the specified string. The fields that are searched include: id, name, description,
	// labels, secret_type.
	//
	// **Usage:** If you want to list only the secrets that contain the string "text", use
	// `../secrets/{secret_type}?search=text`.
	Search *string `json:"search,omitempty"`

	// Sort a list of secrets by the specified field.
	//
	// **Usage:** To sort a list of secrets by their creation date, use
	// `../secrets/{secret_type}?sort_by=creation_date`.
	SortBy *string `json:"sort_by,omitempty"`

	// Filter secrets by groups.
	//
	// You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets
	// that are in the default secret group, use the `default` keyword.
	//
	// **Usage:** To retrieve a list of secrets that are associated with an existing secret group or the default group, use
	// `..?groups={secret_group_ID},default`.
	Groups []string `json:"groups,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAllSecretsOptions : The ListAllSecrets options.

func (*ListAllSecretsOptions) SetGroups added in v0.1.20

func (_options *ListAllSecretsOptions) SetGroups(groups []string) *ListAllSecretsOptions

SetGroups : Allow user to set Groups

func (*ListAllSecretsOptions) SetHeaders

func (options *ListAllSecretsOptions) SetHeaders(param map[string]string) *ListAllSecretsOptions

SetHeaders : Allow user to set Headers

func (*ListAllSecretsOptions) SetLimit

func (_options *ListAllSecretsOptions) SetLimit(limit int64) *ListAllSecretsOptions

SetLimit : Allow user to set Limit

func (*ListAllSecretsOptions) SetOffset

func (_options *ListAllSecretsOptions) SetOffset(offset int64) *ListAllSecretsOptions

SetOffset : Allow user to set Offset

func (*ListAllSecretsOptions) SetSearch

func (_options *ListAllSecretsOptions) SetSearch(search string) *ListAllSecretsOptions

SetSearch : Allow user to set Search

func (*ListAllSecretsOptions) SetSortBy

func (_options *ListAllSecretsOptions) SetSortBy(sortBy string) *ListAllSecretsOptions

SetSortBy : Allow user to set SortBy

type ListInstanceSecretsLocksOptions added in v1.0.45

type ListInstanceSecretsLocksOptions struct {
	// The number of secrets with associated locks to retrieve. By default, list operations return the first 25 items. To
	// retrieve a different set of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5, use
	// `..?limit=5`.
	Limit *int64 `json:"limit,omitempty"`

	// The number of secrets to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`
	// value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 secrets in your instance, and you want to retrieve secrets 26 through 50, use
	// `..?offset=25&limit=25`.
	Offset *int64 `json:"offset,omitempty"`

	// Filter locks that contain the specified string in the field "name".
	//
	// **Usage:** If you want to list only the locks that contain the string "text" in the field "name", use
	// `..?search=text`.
	Search *string `json:"search,omitempty"`

	// Filter secrets by groups.
	//
	// You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets
	// that are in the default secret group, use the `default` keyword.
	//
	// **Usage:** To retrieve a list of secrets that are associated with an existing secret group or the default group, use
	// `..?groups={secret_group_ID},default`.
	Groups []string `json:"groups,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListInstanceSecretsLocksOptions : The ListInstanceSecretsLocks options.

func (*ListInstanceSecretsLocksOptions) SetGroups added in v1.0.45

SetGroups : Allow user to set Groups

func (*ListInstanceSecretsLocksOptions) SetHeaders added in v1.0.45

SetHeaders : Allow user to set Headers

func (*ListInstanceSecretsLocksOptions) SetLimit added in v1.0.45

SetLimit : Allow user to set Limit

func (*ListInstanceSecretsLocksOptions) SetOffset added in v1.0.45

SetOffset : Allow user to set Offset

func (*ListInstanceSecretsLocksOptions) SetSearch added in v1.0.45

SetSearch : Allow user to set Search

type ListSecretGroupsOptions

type ListSecretGroupsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListSecretGroupsOptions : The ListSecretGroups options.

func (*ListSecretGroupsOptions) SetHeaders

func (options *ListSecretGroupsOptions) SetHeaders(param map[string]string) *ListSecretGroupsOptions

SetHeaders : Allow user to set Headers

type ListSecretLocks added in v1.0.45

type ListSecretLocks struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretLockData `json:"resources" validate:"required"`
}

ListSecretLocks : Properties that describe the locks of a secret or a secret version.

type ListSecretVersions added in v1.0.28

type ListSecretVersions struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretVersionInfoIntf `json:"resources,omitempty"`
}

ListSecretVersions : Properties that describe a list of versions of a secret.

type ListSecretVersionsOptions added in v1.0.28

type ListSecretVersionsOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListSecretVersionsOptions : The ListSecretVersions options.

func (*ListSecretVersionsOptions) SetHeaders added in v1.0.28

func (options *ListSecretVersionsOptions) SetHeaders(param map[string]string) *ListSecretVersionsOptions

SetHeaders : Allow user to set Headers

func (*ListSecretVersionsOptions) SetID added in v1.0.28

SetID : Allow user to set ID

func (*ListSecretVersionsOptions) SetSecretType added in v1.0.28

func (_options *ListSecretVersionsOptions) SetSecretType(secretType string) *ListSecretVersionsOptions

SetSecretType : Allow user to set SecretType

type ListSecrets

type ListSecrets struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretResourceIntf `json:"resources,omitempty"`
}

ListSecrets : Properties that describe a list of secrets.

type ListSecretsOptions

type ListSecretsOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The number of secrets to retrieve. By default, list operations return the first 200 items. To retrieve a different
	// set of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5 secrets, use
	// `../secrets/{secret_type}?limit=5`.
	Limit *int64 `json:"limit,omitempty"`

	// The number of secrets to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`
	// value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 secrets in your instance, and you want to retrieve secrets 26 through 50, use
	// `..?offset=25&limit=25`.
	Offset *int64 `json:"offset,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListSecretsOptions : The ListSecrets options.

func (*ListSecretsOptions) SetHeaders

func (options *ListSecretsOptions) SetHeaders(param map[string]string) *ListSecretsOptions

SetHeaders : Allow user to set Headers

func (*ListSecretsOptions) SetLimit

func (_options *ListSecretsOptions) SetLimit(limit int64) *ListSecretsOptions

SetLimit : Allow user to set Limit

func (*ListSecretsOptions) SetOffset

func (_options *ListSecretsOptions) SetOffset(offset int64) *ListSecretsOptions

SetOffset : Allow user to set Offset

func (*ListSecretsOptions) SetSecretType

func (_options *ListSecretsOptions) SetSecretType(secretType string) *ListSecretsOptions

SetSecretType : Allow user to set SecretType

type LockSecretBodyLocksItem added in v1.0.45

type LockSecretBodyLocksItem struct {
	// A human-readable name to assign to the lock. The lock name must be unique per secret version.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a name for your secret lock.
	Name *string `json:"name" validate:"required"`

	// An extended description of the lock.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for your secret
	// lock.
	Description *string `json:"description,omitempty"`

	// Optional information to associate with a lock, such as resources CRNs to be used by automation.
	Attributes map[string]interface{} `json:"attributes,omitempty"`
}

LockSecretBodyLocksItem : LockSecretBodyLocksItem struct

type LockSecretOptions added in v1.0.45

type LockSecretOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The lock data to be attached to a secret version.
	Locks []LockSecretBodyLocksItem `json:"locks,omitempty"`

	// An optional lock mode. At lock creation, you can set one of the following modes to clear any matching locks on a
	// secret version. Note: When you are locking the `previous` version, the mode parameter is ignored.
	//
	// - `exclusive`: Removes any other locks with matching names if they are found in the previous version of the secret.
	// - `exclusive_delete`: Same as `exclusive`, but also permanently deletes the data of the previous secret version if
	// it doesn't have any locks.
	Mode *string `json:"mode,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

LockSecretOptions : The LockSecret options.

func (*LockSecretOptions) SetHeaders added in v1.0.45

func (options *LockSecretOptions) SetHeaders(param map[string]string) *LockSecretOptions

SetHeaders : Allow user to set Headers

func (*LockSecretOptions) SetID added in v1.0.45

func (_options *LockSecretOptions) SetID(id string) *LockSecretOptions

SetID : Allow user to set ID

func (*LockSecretOptions) SetLocks added in v1.0.45

func (_options *LockSecretOptions) SetLocks(locks []LockSecretBodyLocksItem) *LockSecretOptions

SetLocks : Allow user to set Locks

func (*LockSecretOptions) SetMode added in v1.0.45

func (_options *LockSecretOptions) SetMode(mode string) *LockSecretOptions

SetMode : Allow user to set Mode

func (*LockSecretOptions) SetSecretType added in v1.0.45

func (_options *LockSecretOptions) SetSecretType(secretType string) *LockSecretOptions

SetSecretType : Allow user to set SecretType

type LockSecretVersionOptions added in v1.0.45

type LockSecretVersionOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

	// The lock data to be attached to a secret version.
	Locks []LockSecretBodyLocksItem `json:"locks,omitempty"`

	// An optional lock mode. At lock creation, you can set one of the following modes to clear any matching locks on a
	// secret version. Note: When you are locking the `previous` version, the mode parameter is ignored.
	//
	// - `exclusive`: Removes any other locks with matching names if they are found in the previous version of the secret.
	// - `exclusive_delete`: Same as `exclusive`, but also permanently deletes the data of the previous secret version if
	// it doesn't have any locks.
	Mode *string `json:"mode,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

LockSecretVersionOptions : The LockSecretVersion options.

func (*LockSecretVersionOptions) SetHeaders added in v1.0.45

func (options *LockSecretVersionOptions) SetHeaders(param map[string]string) *LockSecretVersionOptions

SetHeaders : Allow user to set Headers

func (*LockSecretVersionOptions) SetID added in v1.0.45

SetID : Allow user to set ID

func (*LockSecretVersionOptions) SetLocks added in v1.0.45

SetLocks : Allow user to set Locks

func (*LockSecretVersionOptions) SetMode added in v1.0.45

func (_options *LockSecretVersionOptions) SetMode(mode string) *LockSecretVersionOptions

SetMode : Allow user to set Mode

func (*LockSecretVersionOptions) SetSecretType added in v1.0.45

func (_options *LockSecretVersionOptions) SetSecretType(secretType string) *LockSecretVersionOptions

SetSecretType : Allow user to set SecretType

func (*LockSecretVersionOptions) SetVersionID added in v1.0.45

func (_options *LockSecretVersionOptions) SetVersionID(versionID string) *LockSecretVersionOptions

SetVersionID : Allow user to set VersionID

type NotificationsSettings added in v1.0.28

type NotificationsSettings struct {
	// The Cloud Resource Name (CRN) of the connected Event Notifications instance.
	EventNotificationsInstanceCRN *string `json:"event_notifications_instance_crn" validate:"required"`
}

NotificationsSettings : The Event Notifications details.

type PrivateCertPolicyRotation added in v1.0.39

type PrivateCertPolicyRotation struct {
	AutoRotate *bool `json:"auto_rotate" validate:"required"`

	// The length of the secret rotation time interval.
	Interval *int64 `json:"interval,omitempty"`

	// The units for the secret rotation time interval.
	Unit *string `json:"unit,omitempty"`
}

PrivateCertPolicyRotation : The `private_cert` secret rotation policy. This model "extends" SecretPolicyRotationRotation

type PrivateCertSecretEngineRootConfig added in v1.0.39

type PrivateCertSecretEngineRootConfig struct {
	// The root certificate authority configurations that are associated with your instance.
	RootCertificateAuthorities []RootCertificateAuthoritiesConfigItem `json:"root_certificate_authorities,omitempty"`

	// The intermediate certificate authority configurations that are associated with your instance.
	IntermediateCertificateAuthorities []IntermediateCertificateAuthoritiesConfigItem `json:"intermediate_certificate_authorities,omitempty"`

	// The certificate templates that are associated with your instance.
	CertificateTemplates []CertificateTemplatesConfigItem `json:"certificate_templates,omitempty"`
}

PrivateCertSecretEngineRootConfig : Configuration for the private certificates engine. This model "extends" GetConfigResourcesItem

type PrivateCertificateSecretMetadata added in v1.0.37

type PrivateCertificateSecretMetadata struct {
	// The unique ID of the secret.
	ID *string `json:"id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be in the range 2 - 30 characters, including spaces. Special characters
	// that are not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies the resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when any part of the secret metadata is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The name of the certificate template.
	CertificateTemplate *string `json:"certificate_template,omitempty"`

	// The intermediate certificate authority that signed this certificate.
	CertificateAuthority *string `json:"certificate_authority,omitempty"`

	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// The alternative names that are defined for the certificate.
	AltNames []string `json:"alt_names,omitempty"`

	Rotation *Rotation `json:"rotation,omitempty"`

	// The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign the
	// certificate.
	Algorithm *string `json:"algorithm,omitempty"`

	// The identifier for the cryptographic algorithm that was used to generate the public and private keys that are
	// associated with the certificate.
	KeyAlgorithm *string `json:"key_algorithm,omitempty"`

	// The certificate authority that signed and issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
}

PrivateCertificateSecretMetadata : Metadata properties that describe a private certificate secret. This model "extends" SecretMetadata

type PrivateCertificateSecretResource added in v1.0.39

type PrivateCertificateSecretResource struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be 2 - 30 characters, including spaces. Special characters that are not
	// permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// An array that contains metadata for each secret version. For more information on the metadata properties, see [Get
	// secret version metadata](#get-secret-version-metadata).
	Versions []map[string]interface{} `json:"versions,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The name of the certificate template.
	CertificateTemplate *string `json:"certificate_template" validate:"required"`

	// The intermediate certificate authority that signed this certificate.
	CertificateAuthority *string `json:"certificate_authority,omitempty"`

	// The certificate signing request. If you don't include this parameter, the CSR that is used to generate the
	// certificate is created internally. If you provide a CSR, it is used also for auto rotation and manual rotation,
	// unless you provide another CSR in the manual rotation request.
	Csr *string `json:"csr,omitempty"`

	// The fully qualified domain name or host domain name for the certificate. If you provide a CSR that includes a common
	// name value, the certificate is generated with the common name that is provided in the CSR.
	CommonName *string `json:"common_name" validate:"required"`

	// The alternative names that are defined for the certificate.
	//
	// For public certificates, this value is provided as an array of strings. For private certificates, this value is
	// provided as a comma-delimited list (string). In the API response, this value is returned as an array of strings for
	// all the types of certificate secrets.
	AltNames interface{} `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to a private certificate.
	//
	// The value can be supplied as a string representation of a duration in hours, for example '12h'. The value can't
	// exceed the `max_ttl` that is defined in the associated certificate template.
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The format of the generated private key.
	PrivateKeyFormat *string `json:"private_key_format,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	Rotation *Rotation `json:"rotation,omitempty"`

	// The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign the
	// certificate.
	Algorithm *string `json:"algorithm,omitempty"`

	// The identifier for the cryptographic algorithm that was used to generate the public and private keys that are
	// associated with the certificate.
	KeyAlgorithm *string `json:"key_algorithm,omitempty"`

	// The certificate authority that signed and issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`

	// The data that is associated with the secret. The data object contains the following fields:
	//
	// - `certificate`: The contents of the certificate.
	// - `private_key`: The private key that is associated with the certificate. If you provide a CSR in the request, the
	// private_key field is not included in the data.
	// - `issuing_ca`: The certificate of the certificate authority that signed and issued this certificate.
	// - `ca_chain`: The chain of certificate authorities that are associated with the certificate.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`
}

PrivateCertificateSecretResource : Properties that describe a secret. This model "extends" SecretResource

type PrivateCertificateSecretVersion added in v1.0.39

type PrivateCertificateSecretVersion struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The data that is associated with the secret version. The data object contains the following fields:
	//
	// - `certificate`: The contents of the certificate.
	// - `private_key`: The private key that is associated with the certificate.
	// - `intermediate`: The intermediate certificate that is associated with the certificate.
	SecretData *CertificateSecretData `json:"secret_data,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`
}

PrivateCertificateSecretVersion : PrivateCertificateSecretVersion struct This model "extends" SecretVersion

type PrivateCertificateSecretVersionInfo added in v1.0.39

type PrivateCertificateSecretVersionInfo struct {
	// The ID of the secret version.
	ID *string `json:"id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`
}

PrivateCertificateSecretVersionInfo : PrivateCertificateSecretVersionInfo struct This model "extends" SecretVersionInfo

type PrivateCertificateSecretVersionMetadata added in v1.0.39

type PrivateCertificateSecretVersionMetadata struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`
}

PrivateCertificateSecretVersionMetadata : Properties that describe a secret version. This model "extends" SecretVersionMetadata

type PublicCertSecretEngineRootConfig added in v1.0.25

type PublicCertSecretEngineRootConfig struct {
	// The certificate authority configurations that are associated with your instance.
	CertificateAuthorities []ConfigElementMetadata `json:"certificate_authorities,omitempty"`

	// The DNS provider configurations that are associated with your instance.
	DNSProviders []ConfigElementMetadata `json:"dns_providers,omitempty"`
}

PublicCertSecretEngineRootConfig : Configuration for the public certificates engine. This model "extends" GetConfigResourcesItem

type PublicCertificateSecretMetadata added in v1.0.28

type PublicCertificateSecretMetadata struct {
	// The unique ID of the secret.
	ID *string `json:"id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be in the range 2 - 30 characters, including spaces. Special characters
	// that are not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies the resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when any part of the secret metadata is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The distinguished name that identifies the entity that signed and issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	// Determines whether your issued certificate is bundled with intermediate certificates.
	//
	// Set to `false` for the certificate file to contain only the issued certificate.
	BundleCerts *bool `json:"bundle_certs,omitempty"`

	// The identifier for the cryptographic algorithm to be used by the issuing certificate authority to sign the
	// certificate.
	Algorithm *string `json:"algorithm,omitempty"`

	// The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the
	// certificate.
	KeyAlgorithm *string `json:"key_algorithm,omitempty"`

	// The alternative names that are defined for the certificate.
	AltNames []string `json:"alt_names,omitempty"`

	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// Indicates whether the certificate was ordered with an associated intermediate certificate.
	IntermediateIncluded *bool `json:"intermediate_included,omitempty"`

	// Indicates whether the certificate was ordered with an associated private key.
	PrivateKeyIncluded *bool `json:"private_key_included,omitempty"`

	Rotation *Rotation `json:"rotation,omitempty"`

	// Issuance information that is associated with your certificate.
	IssuanceInfo *IssuanceInfo `json:"issuance_info,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`
}

PublicCertificateSecretMetadata : Metadata properties that describe a public certificate secret. This model "extends" SecretMetadata

type PublicCertificateSecretResource added in v1.0.25

type PublicCertificateSecretResource struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be 2 - 30 characters, including spaces. Special characters that are not
	// permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// An array that contains metadata for each secret version. For more information on the metadata properties, see [Get
	// secret version metadata](#get-secret-version-metadata).
	Versions []map[string]interface{} `json:"versions,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The distinguished name that identifies the entity that signed and issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	// Determines whether your issued certificate is bundled with intermediate certificates.
	//
	// Set to `false` for the certificate file to contain only the issued certificate.
	BundleCerts *bool `json:"bundle_certs,omitempty"`

	// The name of the certificate authority configuration.
	//
	// To view a list of your configured authorities, use the [List configurations API](#get-secret-config-element).
	Ca *string `json:"ca,omitempty"`

	// The name of the DNS provider configuration.
	//
	// To view a list of your configured authorities, use the [List configurations API](#get-secret-config-element).
	DNS *string `json:"dns,omitempty"`

	// The identifier for the cryptographic algorithm to be used by the issuing certificate authority to sign the
	// certificate.
	Algorithm *string `json:"algorithm,omitempty"`

	// The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the
	// certificate.
	//
	// The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to
	// generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide
	// more encryption protection.
	KeyAlgorithm *string `json:"key_algorithm,omitempty"`

	// The alternative names that are defined for the certificate.
	//
	// For public certificates, this value is provided as an array of strings. For private certificates, this value is
	// provided as a comma-delimited list (string). In the API response, this value is returned as an array of strings for
	// all the types of certificate secrets.
	AltNames interface{} `json:"alt_names,omitempty"`

	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// Indicates whether the issued certificate includes a private key.
	PrivateKeyIncluded *bool `json:"private_key_included,omitempty"`

	// Indicates whether the issued certificate includes an intermediate certificate.
	IntermediateIncluded *bool `json:"intermediate_included,omitempty"`

	Rotation *Rotation `json:"rotation,omitempty"`

	// Issuance information that is associated with your certificate.
	IssuanceInfo *IssuanceInfo `json:"issuance_info,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The data that is associated with the secret. The data object contains the following fields:
	//
	// - `certificate`: The contents of the certificate.
	// - `private_key`: The private key that is associated with the certificate.
	// - `intermediate`: The intermediate certificate that is associated with the certificate.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`
}

PublicCertificateSecretResource : Properties that describe a secret. This model "extends" SecretResource

type PutConfigOptions

type PutConfigOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// Properties to update for a secrets engine.
	EngineConfig EngineConfigIntf `json:"EngineConfig" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutConfigOptions : The PutConfig options.

func (*PutConfigOptions) SetEngineConfig added in v1.0.22

func (_options *PutConfigOptions) SetEngineConfig(engineConfig EngineConfigIntf) *PutConfigOptions

SetEngineConfig : Allow user to set EngineConfig

func (*PutConfigOptions) SetHeaders

func (options *PutConfigOptions) SetHeaders(param map[string]string) *PutConfigOptions

SetHeaders : Allow user to set Headers

func (*PutConfigOptions) SetSecretType

func (_options *PutConfigOptions) SetSecretType(secretType string) *PutConfigOptions

SetSecretType : Allow user to set SecretType

type PutPolicyOptions

type PutPolicyOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretPolicyRotation `json:"resources" validate:"required"`

	// The type of policy that is associated with the specified secret.
	Policy *string `json:"policy,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PutPolicyOptions : The PutPolicy options.

func (*PutPolicyOptions) SetHeaders

func (options *PutPolicyOptions) SetHeaders(param map[string]string) *PutPolicyOptions

SetHeaders : Allow user to set Headers

func (*PutPolicyOptions) SetID

func (_options *PutPolicyOptions) SetID(id string) *PutPolicyOptions

SetID : Allow user to set ID

func (*PutPolicyOptions) SetMetadata

func (_options *PutPolicyOptions) SetMetadata(metadata *CollectionMetadata) *PutPolicyOptions

SetMetadata : Allow user to set Metadata

func (*PutPolicyOptions) SetPolicy

func (_options *PutPolicyOptions) SetPolicy(policy string) *PutPolicyOptions

SetPolicy : Allow user to set Policy

func (*PutPolicyOptions) SetResources

func (_options *PutPolicyOptions) SetResources(resources []SecretPolicyRotation) *PutPolicyOptions

SetResources : Allow user to set Resources

func (*PutPolicyOptions) SetSecretType

func (_options *PutPolicyOptions) SetSecretType(secretType string) *PutPolicyOptions

SetSecretType : Allow user to set SecretType

type RestoreIamCredentialsSecretBody added in v1.0.28

type RestoreIamCredentialsSecretBody struct {
	// The ID of the target version or the alias `previous`.
	VersionID *string `json:"version_id" validate:"required"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

RestoreIamCredentialsSecretBody : The request body of a `restore` action. This model "extends" SecretAction

type RevokeAction added in v1.0.39

type RevokeAction struct {
	// The serial number of the certificate.
	SerialNumber *string `json:"serial_number" validate:"required"`
}

RevokeAction : A request to revoke the certificate of an internally signed intermediate certificate authority. This model "extends" ConfigAction

type RevokeActionResult added in v1.0.39

type RevokeActionResult struct {
	// The time until the certificate authority is revoked.
	RevocationTime *int64 `json:"revocation_time,omitempty"`
}

RevokeActionResult : Properties that are returned with a successful `revoke` action. This model "extends" ConfigElementActionResultConfig

type RootCertificateAuthoritiesConfig added in v1.0.39

type RootCertificateAuthoritiesConfig struct {
	RootCertificateAuthorities []RootCertificateAuthoritiesConfigItem `json:"root_certificate_authorities" validate:"required"`
}

RootCertificateAuthoritiesConfig : Root certificate authorities configuration. This model "extends" GetConfigElementsResourcesItem

type RootCertificateAuthoritiesConfigItem added in v1.0.39

type RootCertificateAuthoritiesConfigItem struct {
	// The human-readable name to assign to your configuration.
	Name *string `json:"name" validate:"required"`

	// The type of configuration. Value options differ depending on the `config_element` property that you want to define.
	Type *string `json:"type" validate:"required"`

	// Root certificate authority configuration.
	Config *RootCertificateAuthorityConfig `json:"config,omitempty"`
}

RootCertificateAuthoritiesConfigItem : Root certificate authorities configuration.

type RootCertificateAuthorityConfig added in v1.0.39

type RootCertificateAuthorityConfig struct {
	// The maximum time-to-live (TTL) for certificates that are created by this CA.
	//
	// The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API
	// response, this value is returned in seconds (integer).
	//
	// Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).
	MaxTTL interface{} `json:"max_ttl" validate:"required"`

	// The time until the certificate revocation list (CRL) expires.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours.
	// In the API response, this value is returned in seconds (integer).
	//
	// **Note:** The CRL is rotated automatically before it expires.
	CrlExpiry interface{} `json:"crl_expiry,omitempty"`

	// Disables or enables certificate revocation list (CRL) building.
	//
	// If CRL building is disabled, a signed but zero-length CRL is returned when downloading the CRL. If CRL building is
	// enabled,  it will rebuild the CRL.
	CrlDisable *bool `json:"crl_disable,omitempty"`

	// Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are
	// issued by this certificate authority.
	CrlDistributionPointsEncoded *bool `json:"crl_distribution_points_encoded,omitempty"`

	// Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this
	// certificate authority.
	IssuingCertificatesUrlsEncoded *bool `json:"issuing_certificates_urls_encoded,omitempty"`

	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name" validate:"required"`

	// The status of the certificate authority. The status of a root certificate authority is either `configured` or
	// `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,
	// `signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.
	Status *string `json:"status,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to this CA certificate.
	//
	// The value can be supplied as a string representation of a duration, such as `12h`. The value can be supplied in
	// seconds (suffix `s`), minutes (suffix `m`), hours (suffix `h`) or days (suffix `d`). The value can't exceed the
	// `max_ttl` that is defined in the associated certificate template. In the API response, this value is returned in
	// seconds (integer).
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The format of the generated private key.
	PrivateKeyFormat *string `json:"private_key_format,omitempty"`

	// The type of private key to generate.
	KeyType *string `json:"key_type,omitempty"`

	// The number of bits to use when generating the private key.
	//
	// Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and
	// `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.
	KeyBits *int64 `json:"key_bits,omitempty"`

	// The maximum path length to encode in the generated certificate. `-1` means no limit.
	//
	// If the signing certificate has a maximum path length set, the path length is set to one less than that of the
	// signing certificate. A limit of `0` means a literal path length of zero.
	MaxPathLength *int64 `json:"max_path_length,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The allowed DNS domains or subdomains for the certificates to be signed and issued by this CA certificate.
	PermittedDNSDomains []string `json:"permitted_dns_domains,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The data that is associated with the root certificate authority. The data object contains the following fields:
	//
	// - `certificate`: The root certificate content.
	// - `issuing_ca`: The certificate of the certificate authority that signed and issued this certificate.
	// - `serial_number`: The unique serial number of the root certificate.
	Data map[string]interface{} `json:"data,omitempty"`
}

RootCertificateAuthorityConfig : Root certificate authority configuration. This model "extends" ConfigElementDefConfig

type RotateArbitrarySecretBody added in v1.0.22

type RotateArbitrarySecretBody struct {
	// The new secret data to assign to an `arbitrary` secret.
	Payload interface{} `json:"payload" validate:"required"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

RotateArbitrarySecretBody : The request body of a `rotate` action. This model "extends" SecretAction

type RotateCertificateBody added in v1.0.22

type RotateCertificateBody struct {
	// The new data to associate with the certificate.
	Certificate *string `json:"certificate" validate:"required"`

	// The new private key to associate with the certificate.
	PrivateKey *string `json:"private_key,omitempty"`

	// The new intermediate certificate to associate with the certificate.
	Intermediate *string `json:"intermediate,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

RotateCertificateBody : The request body of a rotate certificate action. This model "extends" SecretAction

type RotateCrlActionResult added in v1.0.39

type RotateCrlActionResult struct {
}

RotateCrlActionResult : Properties that are returned with a successful `rotate_crl` action. This model "extends" ConfigElementActionResultConfig

type RotateKvSecretBody added in v1.0.30

type RotateKvSecretBody struct {
	// The new secret data to assign to a key-value secret.
	Payload map[string]interface{} `json:"payload" validate:"required"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

RotateKvSecretBody : The request body of a `rotate` action. This model "extends" SecretAction

type RotatePrivateCertBody added in v1.0.46

type RotatePrivateCertBody struct {
	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata" validate:"required"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

RotatePrivateCertBody : The request body of a rotate private certificate action. This model "extends" SecretAction

type RotatePrivateCertBodyWithCsr added in v1.0.48

type RotatePrivateCertBodyWithCsr struct {
	// The certificate signing request. If you provide a CSR, it is used for auto rotation and manual rotation requests
	// that do not include a CSR. If you don't include the CSR, the certificate is generated with the last CSR that you
	// provided to create the private certificate, or on a previous request to rotate the certificate. If no CSR was
	// provided in the past, the certificate is generated with a CSR that is created internally.
	Csr *string `json:"csr" validate:"required"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

RotatePrivateCertBodyWithCsr : The body of a request to rotate a private certificate. This model "extends" SecretAction

type RotatePrivateCertBodyWithVersionCustomMetadata added in v1.0.46

type RotatePrivateCertBodyWithVersionCustomMetadata struct {
	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata" validate:"required"`
}

RotatePrivateCertBodyWithVersionCustomMetadata : The request body of a rotate private certificate action. This model "extends" SecretAction

type RotatePublicCertBody added in v1.0.25

type RotatePublicCertBody struct {
	// Determine whether keys must be rotated.
	RotateKeys *bool `json:"rotate_keys" validate:"required"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

RotatePublicCertBody : The request body of a `rotate` action. This model "extends" SecretAction

type RotateUsernamePasswordSecretBody added in v1.0.22

type RotateUsernamePasswordSecretBody struct {
	// The new password to assign to a `username_password` secret.
	Password *string `json:"password" validate:"required"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

RotateUsernamePasswordSecretBody : The request body of a `rotate` action. This model "extends" SecretAction

type Rotation added in v1.0.25

type Rotation struct {
	// Determines whether Secrets Manager rotates your certificate automatically.
	//
	// For public certificates, if `auto_rotate` is set to `true` the service reorders your certificate 31 days before it
	// expires. For private certificates, the certificate is rotated according to the time interval specified in the
	// `interval` and `unit` fields.
	//
	// To access the previous version of the certificate, you can use the
	// [Get a version of a secret](#get-secret-version) method.
	AutoRotate *bool `json:"auto_rotate,omitempty"`

	// Determines whether Secrets Manager rotates the private key for your certificate automatically.
	//
	// If set to `true`, the service generates and stores a new private key for your rotated certificate.
	//
	// **Note:** Use this field only for public certificates. It is ignored for private certificates.
	RotateKeys *bool `json:"rotate_keys,omitempty"`

	// Used together with the `unit` field to specify the rotation interval. The minimum interval is one day, and the
	// maximum interval is 3 years (1095 days). Required in case `auto_rotate` is set to `true`.
	//
	// **Note:** Use this field only for private certificates. It is ignored for public certificates.
	Interval *int64 `json:"interval,omitempty"`

	// The time unit of the rotation interval.
	//
	// **Note:** Use this field only for private certificates. It is ignored for public certificates.
	Unit *string `json:"unit,omitempty"`
}

Rotation : Rotation struct

type SecretAction added in v1.0.22

type SecretAction struct {
	// The new secret data to assign to an `arbitrary` secret.
	Payload interface{} `json:"payload,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Determine whether keys must be rotated.
	RotateKeys *bool `json:"rotate_keys,omitempty"`

	// The new password to assign to a `username_password` secret.
	Password *string `json:"password,omitempty"`

	// The new data to associate with the certificate.
	Certificate *string `json:"certificate,omitempty"`

	// The new private key to associate with the certificate.
	PrivateKey *string `json:"private_key,omitempty"`

	// The new intermediate certificate to associate with the certificate.
	Intermediate *string `json:"intermediate,omitempty"`

	// The certificate signing request. If you provide a CSR, it is used for auto rotation and manual rotation requests
	// that do not include a CSR. If you don't include the CSR, the certificate is generated with the last CSR that you
	// provided to create the private certificate, or on a previous request to rotate the certificate. If no CSR was
	// provided in the past, the certificate is generated with a CSR that is created internally.
	Csr *string `json:"csr,omitempty"`

	// The ID of the target version or the alias `previous`.
	VersionID *string `json:"version_id,omitempty"`

	// The ID of the API key that you want to delete. If the secret was created with a static service ID, only the API key
	// is deleted. Otherwise, the service ID is deleted together with its API key.
	APIKeyID *string `json:"api_key_id,omitempty"`

	// The service ID that you want to delete. This property can be used instead of the `api_key_id` field, but only for
	// secrets that were created with a service ID that was generated by Secrets Manager.
	//
	// **Deprecated.** Use the `api_key_id` field instead.
	// Deprecated: this field is deprecated and may be removed in a future release.
	ServiceID *string `json:"service_id,omitempty"`
}

SecretAction : SecretAction struct Models which "extend" this model: - RotateArbitrarySecretBody - RotatePublicCertBody - RotateUsernamePasswordSecretBody - RotateCertificateBody - RotatePrivateCertBody - RotatePrivateCertBodyWithCsr - RotatePrivateCertBodyWithVersionCustomMetadata - RestoreIamCredentialsSecretBody - DeleteCredentialsForIamCredentialsSecret - RotateKvSecretBody

type SecretActionIntf added in v1.0.22

type SecretActionIntf interface {
	// contains filtered or unexported methods
}

type SecretGroupDef

type SecretGroupDef struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretGroupResource `json:"resources" validate:"required"`
}

SecretGroupDef : Properties that describe a secret group.

type SecretGroupMetadataUpdatable

type SecretGroupMetadataUpdatable struct {
	// A human-readable name to assign to your secret group.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a name for your secret group.
	Name *string `json:"name,omitempty"`

	// An extended description of your secret group.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for your secret
	// group.
	Description *string `json:"description,omitempty"`
}

SecretGroupMetadataUpdatable : Metadata properties to update for a secret group.

type SecretGroupResource

type SecretGroupResource struct {
	// The v4 UUID that uniquely identifies the secret group.
	ID *string `json:"id,omitempty"`

	// A human-readable name to assign to your secret group.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a name for your secret group.
	Name *string `json:"name,omitempty"`

	// An extended description of your secret group.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for your secret
	// group.
	Description *string `json:"description,omitempty"`

	// The date the secret group was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// Updates when the metadata of the secret group is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The MIME type that represents the secret group.
	Type *string `json:"type,omitempty"`
	// contains filtered or unexported fields
}

SecretGroupResource : Properties that describe a secret group.

func (*SecretGroupResource) GetProperties

func (o *SecretGroupResource) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretGroupResource

func (*SecretGroupResource) GetProperty

func (o *SecretGroupResource) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretGroupResource

func (*SecretGroupResource) MarshalJSON

func (o *SecretGroupResource) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretGroupResource

func (*SecretGroupResource) SetProperties added in v1.0.25

func (o *SecretGroupResource) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretGroupResource

func (*SecretGroupResource) SetProperty

func (o *SecretGroupResource) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of SecretGroupResource

type SecretLockData added in v1.0.45

type SecretLockData struct {
	// A human-readable name to assign to the secret lock.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a name for the secret lock.
	Name *string `json:"name,omitempty"`

	// An extended description of the secret lock.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for the secret
	// lock.
	Description *string `json:"description,omitempty"`

	// The date the secret lock was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret lock.
	CreatedBy *string `json:"created_by,omitempty"`

	// The information that is associated with a lock, such as resources CRNs to be used by automation.
	Attributes map[string]interface{} `json:"attributes,omitempty"`

	// The v4 UUID that uniquely identifies the secret version.
	SecretVersionID *string `json:"secret_version_id,omitempty"`

	// The v4 UUID that uniquely identifies the secret.
	SecretID *string `json:"secret_id,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// A representation for the 2 last secret versions. Could be "current" for version (n) or "previous" for version (n-1).
	SecretVersionAlias *string `json:"secret_version_alias,omitempty"`
}

SecretLockData : Properties that describe a lock.

type SecretLockVersion added in v1.0.45

type SecretLockVersion struct {
	// The v4 UUID that uniquely identifies the lock.
	ID *string `json:"id,omitempty"`

	// A human-readable alias that describes the secret version. 'Current' is used for version `n` and 'previous' is used
	// for version `n-1`.
	Alias *string `json:"alias,omitempty"`

	// The names of all locks that are associated with this secret.
	Locks []string `json:"locks,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`
	// contains filtered or unexported fields
}

SecretLockVersion : Properties that describe the secret locks.

func (*SecretLockVersion) GetProperties added in v1.0.45

func (o *SecretLockVersion) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretLockVersion

func (*SecretLockVersion) GetProperty added in v1.0.45

func (o *SecretLockVersion) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretLockVersion

func (*SecretLockVersion) MarshalJSON added in v1.0.45

func (o *SecretLockVersion) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretLockVersion

func (*SecretLockVersion) SetProperties added in v1.0.45

func (o *SecretLockVersion) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretLockVersion

func (*SecretLockVersion) SetProperty added in v1.0.45

func (o *SecretLockVersion) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of SecretLockVersion

type SecretMetadata

type SecretMetadata struct {
	// The unique ID of the secret.
	ID *string `json:"id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be in the range 2 - 30 characters, including spaces. Special characters
	// that are not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name,omitempty"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies the resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when any part of the secret metadata is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The date the secret material expires. The date format follows RFC 3339.
	//
	// You can set an expiration date on supported secret types at their creation. If you create a secret without
	// specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
	// following secret types:
	//
	// - `arbitrary`
	// - `username_password`.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The time-to-live (TTL) or lease duration that is assigned to the secret. For `iam_credentials` secrets, the TTL
	// defines for how long each generated API key remains valid.
	TTL *string `json:"ttl,omitempty"`

	// Determines whether to use the same service ID and API key for future read operations on an
	// `iam_credentials` secret.
	//
	// If set to `true`, the service reuses the current credentials. If set to `false`, a new service ID and API key are
	// generated each time that the secret is read or accessed.
	ReuseAPIKey *bool `json:"reuse_api_key,omitempty"`

	// Indicates whether an `iam_credentials` secret was created with a static service ID.
	//
	// If the value is `true`, the service ID for the secret was provided by the user at secret creation. If the value is
	// `false`, the service ID was generated by Secrets Manager.
	ServiceIDIsStatic *bool `json:"service_id_is_static,omitempty"`

	// The service ID under which the API key is created. The service ID is included in the metadata only if the secret was
	// created with a static service ID.
	ServiceID *string `json:"service_id,omitempty"`

	// The access groups that define the capabilities of the service ID and API key that are generated for an
	// `iam_credentials` secret. The access groups are included in the metadata only if the secret was created with a
	// service ID that was generated by Secrets Manager.
	AccessGroups []string `json:"access_groups,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign the
	// certificate.
	Algorithm *string `json:"algorithm,omitempty"`

	// The identifier for the cryptographic algorithm that was used to generate the public and private keys that are
	// associated with the certificate.
	KeyAlgorithm *string `json:"key_algorithm,omitempty"`

	// The distinguished name that identifies the entity that signed and issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The fully qualified domain name or host domain name that is defined for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// Indicates whether the certificate was imported with an associated intermediate certificate.
	IntermediateIncluded *bool `json:"intermediate_included,omitempty"`

	// Indicates whether the certificate was imported with an associated private key.
	PrivateKeyIncluded *bool `json:"private_key_included,omitempty"`

	// The alternative names that are defined for the certificate.
	AltNames []string `json:"alt_names,omitempty"`

	// Determines whether your issued certificate is bundled with intermediate certificates.
	//
	// Set to `false` for the certificate file to contain only the issued certificate.
	BundleCerts *bool `json:"bundle_certs,omitempty"`

	Rotation *Rotation `json:"rotation,omitempty"`

	// Issuance information that is associated with your certificate.
	IssuanceInfo *IssuanceInfo `json:"issuance_info,omitempty"`

	// The name of the certificate template.
	CertificateTemplate *string `json:"certificate_template,omitempty"`

	// The intermediate certificate authority that signed this certificate.
	CertificateAuthority *string `json:"certificate_authority,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
}

SecretMetadata : SecretMetadata struct Models which "extend" this model: - ArbitrarySecretMetadata - UsernamePasswordSecretMetadata - IamCredentialsSecretMetadata - CertificateSecretMetadata - PublicCertificateSecretMetadata - PrivateCertificateSecretMetadata - KvSecretMetadata

type SecretMetadataIntf added in v1.0.22

type SecretMetadataIntf interface {
	// contains filtered or unexported methods
}

type SecretMetadataRequest

type SecretMetadataRequest struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretMetadataIntf `json:"resources" validate:"required"`
}

SecretMetadataRequest : The metadata of a secret.

type SecretPolicyRotation

type SecretPolicyRotation struct {
	// The MIME type that represents the policy. Currently, only the default is supported.
	Type *string `json:"type" validate:"required"`

	Rotation SecretPolicyRotationRotationIntf `json:"rotation" validate:"required"`
}

SecretPolicyRotation : Properties that describe a rotation policy.

type SecretPolicyRotationRotation

type SecretPolicyRotationRotation struct {
	// The length of the secret rotation time interval.
	Interval *int64 `json:"interval,omitempty"`

	// The units for the secret rotation time interval.
	Unit *string `json:"unit,omitempty"`

	AutoRotate *bool `json:"auto_rotate,omitempty"`

	RotateKeys *bool `json:"rotate_keys,omitempty"`
}

SecretPolicyRotationRotation : SecretPolicyRotationRotation struct Models which "extend" this model: - SecretPolicyRotationRotationPolicyRotation - SecretPolicyRotationRotationPublicCertPolicyRotation - PrivateCertPolicyRotation

type SecretPolicyRotationRotationIntf added in v1.0.25

type SecretPolicyRotationRotationIntf interface {
	// contains filtered or unexported methods
}

type SecretPolicyRotationRotationPolicyRotation added in v1.0.25

type SecretPolicyRotationRotationPolicyRotation struct {
	// The length of the secret rotation time interval.
	Interval *int64 `json:"interval" validate:"required"`

	// The units for the secret rotation time interval.
	Unit *string `json:"unit" validate:"required"`
}

SecretPolicyRotationRotationPolicyRotation : The secret rotation time interval. This model "extends" SecretPolicyRotationRotation

type SecretPolicyRotationRotationPublicCertPolicyRotation added in v1.0.25

type SecretPolicyRotationRotationPublicCertPolicyRotation struct {
	AutoRotate *bool `json:"auto_rotate" validate:"required"`

	RotateKeys *bool `json:"rotate_keys" validate:"required"`
}

SecretPolicyRotationRotationPublicCertPolicyRotation : The `public_cert` secret rotation policy. This model "extends" SecretPolicyRotationRotation

type SecretResource

type SecretResource struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name,omitempty"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be 2 - 30 characters, including spaces. Special characters that are not
	// permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// An array that contains metadata for each secret version. For more information on the metadata properties, see [Get
	// secret version metadata](#get-secret-version-metadata).
	Versions []map[string]interface{} `json:"versions,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The date the secret material expires. The date format follows RFC 3339.
	//
	// You can set an expiration date on supported secret types at their creation. If you create a secret without
	// specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
	// following secret types:
	//
	// - `arbitrary`
	// - `username_password`.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The new secret data to assign to the secret.
	Payload interface{} `json:"payload,omitempty"`

	// The data that is associated with the secret version.
	//
	// The data object contains the field `payload`.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`

	// The username to assign to this secret.
	Username *string `json:"username,omitempty"`

	// The password to assign to this secret.
	Password *string `json:"password,omitempty"`

	// 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 can be auto-rotated and have an existing rotation policy.
	NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`

	// The time-to-live (TTL) or lease duration to assign to generated credentials.
	//
	// For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be
	// either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m`
	// or `24h`.
	//
	// Minimum duration is 1 minute. Maximum is 90 days.
	TTL interface{} `json:"ttl,omitempty"`

	// The access groups that define the capabilities of the service ID and API key that are generated for an
	// `iam_credentials` secret. If you prefer to use an existing service ID that is already assigned the access policies
	// that you require, you can omit this parameter and use the `service_id` field instead.
	//
	// **Tip:** To list the access groups that are available in an account, you can use the [IAM Access Groups
	// API](https://cloud.ibm.com/apidocs/iam-access-groups#list-access-groups). To find the ID of an access group in the
	// console, go to **Manage > Access (IAM) > Access groups**. Select the access group to inspect, and click **Details**
	// to view its ID.
	AccessGroups []string `json:"access_groups,omitempty"`

	// The API key that is generated for this secret.
	//
	// After the secret reaches the end of its lease (see the `ttl` field), the API key is deleted automatically. If you
	// want to continue to use the same API key for future read operations, see the `reuse_api_key` field.
	APIKey *string `json:"api_key,omitempty"`

	// The ID of the API key that is generated for this secret.
	APIKeyID *string `json:"api_key_id,omitempty"`

	// The service ID under which the API key (see the `api_key` field) is created.
	//
	// If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it
	// to the access groups that you assign.
	//
	// Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or
	// retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include
	// the `access_groups` parameter.
	ServiceID *string `json:"service_id,omitempty"`

	// Indicates whether an `iam_credentials` secret was created with a static service ID.
	//
	// If `true`, the service ID for the secret was provided by the user at secret creation. If `false`, the service ID was
	// generated by Secrets Manager.
	ServiceIDIsStatic *bool `json:"service_id_is_static,omitempty"`

	// Determines whether to use the same service ID and API key for future read operations on an
	// `iam_credentials` secret.
	//
	// If set to `true`, the service reuses the current credentials. If set to `false`, a new service ID and API key are
	// generated each time that the secret is read or accessed.
	ReuseAPIKey *bool `json:"reuse_api_key,omitempty"`

	// The contents of your certificate. The data must be formatted on a single line with embedded newline characters.
	Certificate *string `json:"certificate,omitempty"`

	// The private key to associate with the certificate. The data must be formatted on a single line with embedded newline
	// characters.
	PrivateKey *string `json:"private_key,omitempty"`

	// The intermediate certificate to associate with the root certificate. The data must be formatted on a single line
	// with embedded newline characters.
	Intermediate *string `json:"intermediate,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign the
	// certificate.
	Algorithm *string `json:"algorithm,omitempty"`

	// The identifier for the cryptographic algorithm that was used to generate the public and private keys that are
	// associated with the certificate.
	KeyAlgorithm *string `json:"key_algorithm,omitempty"`

	// The distinguished name that identifies the entity that signed and issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The fully qualified domain name or host domain name that is defined for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// Indicates whether the certificate was imported with an associated intermediate certificate.
	IntermediateIncluded *bool `json:"intermediate_included,omitempty"`

	// Indicates whether the certificate was imported with an associated private key.
	PrivateKeyIncluded *bool `json:"private_key_included,omitempty"`

	// The alternative names that are defined for the certificate.
	//
	// For public certificates, this value is provided as an array of strings. For private certificates, this value is
	// provided as a comma-delimited list (string). In the API response, this value is returned as an array of strings for
	// all the types of certificate secrets.
	AltNames interface{} `json:"alt_names,omitempty"`

	// Determines whether your issued certificate is bundled with intermediate certificates.
	//
	// Set to `false` for the certificate file to contain only the issued certificate.
	BundleCerts *bool `json:"bundle_certs,omitempty"`

	// The name of the certificate authority configuration.
	//
	// To view a list of your configured authorities, use the [List configurations API](#get-secret-config-element).
	Ca *string `json:"ca,omitempty"`

	// The name of the DNS provider configuration.
	//
	// To view a list of your configured authorities, use the [List configurations API](#get-secret-config-element).
	DNS *string `json:"dns,omitempty"`

	Rotation *Rotation `json:"rotation,omitempty"`

	// Issuance information that is associated with your certificate.
	IssuanceInfo *IssuanceInfo `json:"issuance_info,omitempty"`

	// The name of the certificate template.
	CertificateTemplate *string `json:"certificate_template,omitempty"`

	// The intermediate certificate authority that signed this certificate.
	CertificateAuthority *string `json:"certificate_authority,omitempty"`

	// The certificate signing request. If you don't include this parameter, the CSR that is used to generate the
	// certificate is created internally. If you provide a CSR, it is used also for auto rotation and manual rotation,
	// unless you provide another CSR in the manual rotation request.
	Csr *string `json:"csr,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The format of the generated private key.
	PrivateKeyFormat *string `json:"private_key_format,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
}

SecretResource : SecretResource struct Models which "extend" this model: - ArbitrarySecretResource - UsernamePasswordSecretResource - IamCredentialsSecretResource - CertificateSecretResource - PublicCertificateSecretResource - PrivateCertificateSecretResource - KvSecretResource

type SecretResourceIntf

type SecretResourceIntf interface {
	// contains filtered or unexported methods
}

type SecretVersion

type SecretVersion struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The data that is associated with the secret version.
	//
	// The data object contains the field `payload`.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
}

SecretVersion : SecretVersion struct Models which "extend" this model: - ArbitrarySecretVersion - UsernamePasswordSecretVersion - IamCredentialsSecretVersion - CertificateSecretVersion - PrivateCertificateSecretVersion

type SecretVersionInfo added in v1.0.28

type SecretVersionInfo struct {
	// The ID of the secret version.
	ID *string `json:"id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
}

SecretVersionInfo : Properties that describe a secret version within a list of secret versions. Models which "extend" this model: - ArbitrarySecretVersionInfo - UsernamePasswordSecretVersionInfo - IamCredentialsSecretVersionInfo - CertificateSecretVersionInfo - PrivateCertificateSecretVersionInfo

type SecretVersionInfoIntf added in v1.0.28

type SecretVersionInfoIntf interface {
	// contains filtered or unexported methods
}

type SecretVersionIntf added in v1.0.22

type SecretVersionIntf interface {
	// contains filtered or unexported methods
}

type SecretVersionMetadata added in v1.0.22

type SecretVersionMetadata struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The date that the certificate expires. The date format follows RFC 3339.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	Validity *CertificateValidity `json:"validity,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The timestamp of the certificate revocation.
	RevocationTime *int64 `json:"revocation_time,omitempty"`

	// The date and time that the certificate was revoked. The date format follows RFC 3339.
	RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
}

SecretVersionMetadata : SecretVersionMetadata struct Models which "extend" this model: - ArbitrarySecretVersionMetadata - UsernamePasswordSecretVersionMetadata - IamCredentialsSecretVersionMetadata - CertificateSecretVersionMetadata - PrivateCertificateSecretVersionMetadata

type SecretVersionMetadataIntf added in v1.0.22

type SecretVersionMetadataIntf interface {
	// contains filtered or unexported methods
}

type SecretsLocks added in v1.0.45

type SecretsLocks struct {
	// The unique ID of the secret.
	SecretID *string `json:"secret_id,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// A collection of locks that are attached to a secret version.
	Versions []SecretLockVersion `json:"versions,omitempty"`
	// contains filtered or unexported fields
}

SecretsLocks : Properties that describe the secret locks.

func (*SecretsLocks) GetProperties added in v1.0.45

func (o *SecretsLocks) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretsLocks

func (*SecretsLocks) GetProperty added in v1.0.45

func (o *SecretsLocks) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretsLocks

func (*SecretsLocks) MarshalJSON added in v1.0.45

func (o *SecretsLocks) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretsLocks

func (*SecretsLocks) SetProperties added in v1.0.45

func (o *SecretsLocks) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretsLocks

func (*SecretsLocks) SetProperty added in v1.0.45

func (o *SecretsLocks) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of SecretsLocks

type SecretsManagerV1

type SecretsManagerV1 struct {
	Service *core.BaseService
}

SecretsManagerV1 : With IBM Cloud® Secrets Manager, you can create, lease, and centrally manage secrets that are used in IBM Cloud services or your custom-built applications. Secrets are stored in a dedicated instance of Secrets Manager, which is built on open source HashiCorp Vault.

API Version: 1.0.0 See: https://cloud.ibm.com/docs/secrets-manager

func NewSecretsManagerV1

func NewSecretsManagerV1(options *SecretsManagerV1Options) (service *SecretsManagerV1, err error)

NewSecretsManagerV1 : constructs an instance of SecretsManagerV1 with passed in options.

func NewSecretsManagerV1UsingExternalConfig

func NewSecretsManagerV1UsingExternalConfig(options *SecretsManagerV1Options) (secretsManager *SecretsManagerV1, err error)

NewSecretsManagerV1UsingExternalConfig : constructs an instance of SecretsManagerV1 with passed in options and external configuration.

func (*SecretsManagerV1) ActionOnConfigElement added in v1.0.39

func (secretsManager *SecretsManagerV1) ActionOnConfigElement(actionOnConfigElementOptions *ActionOnConfigElementOptions) (result *ConfigElementActionResult, response *core.DetailedResponse, err error)

ActionOnConfigElement : Invoke an action on a configuration Invoke an action on a specified configuration element. This method supports the following actions:

- `sign_intermediate`: Sign an intermediate certificate authority. - `sign_csr`: Sign a certificate signing request. - `set_signed`: Set a signed intermediate certificate authority. - `revoke`: Revoke an internally signed intermediate certificate authority certificate. - `rotate_crl`: Rotate the certificate revocation list (CRL) of an intermediate certificate authority.

func (*SecretsManagerV1) ActionOnConfigElementWithContext added in v1.0.39

func (secretsManager *SecretsManagerV1) ActionOnConfigElementWithContext(ctx context.Context, actionOnConfigElementOptions *ActionOnConfigElementOptions) (result *ConfigElementActionResult, response *core.DetailedResponse, err error)

ActionOnConfigElementWithContext is an alternate form of the ActionOnConfigElement method which supports a Context parameter

func (*SecretsManagerV1) Clone

func (secretsManager *SecretsManagerV1) Clone() *SecretsManagerV1

Clone makes a copy of "secretsManager" suitable for processing requests.

func (*SecretsManagerV1) CreateConfigElement added in v1.0.25

func (secretsManager *SecretsManagerV1) CreateConfigElement(createConfigElementOptions *CreateConfigElementOptions) (result *GetSingleConfigElement, response *core.DetailedResponse, err error)

CreateConfigElement : Add a configuration Add a configuration element to the specified secret type.

Use this method to define the configurations that are required to enable the public certificates (`public_cert`) and private certificates (`private_cert`) engines.

You can add multiple configurations for your instance as follows:

- Up to 10 public certificate authority configurations - Up to 10 DNS provider configurations - Up to 10 private root certificate authority configurations - Up to 10 private intermediate certificate authority configurations - Up to 10 certificate templates.

func (*SecretsManagerV1) CreateConfigElementWithContext added in v1.0.25

func (secretsManager *SecretsManagerV1) CreateConfigElementWithContext(ctx context.Context, createConfigElementOptions *CreateConfigElementOptions) (result *GetSingleConfigElement, response *core.DetailedResponse, err error)

CreateConfigElementWithContext is an alternate form of the CreateConfigElement method which supports a Context parameter

func (*SecretsManagerV1) CreateNotificationsRegistration added in v1.0.28

func (secretsManager *SecretsManagerV1) CreateNotificationsRegistration(createNotificationsRegistrationOptions *CreateNotificationsRegistrationOptions) (result *GetNotificationsSettings, response *core.DetailedResponse, err error)

CreateNotificationsRegistration : Register with Event Notifications Create a registration between a Secrets Manager instance and [Event Notifications](https://cloud.ibm.com/apidocs/event-notifications).

A successful request adds Secrets Manager as a source that you can reference from your Event Notifications instance. For more information about enabling notifications for Secrets Manager, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-event-notifications).

func (*SecretsManagerV1) CreateNotificationsRegistrationWithContext added in v1.0.28

func (secretsManager *SecretsManagerV1) CreateNotificationsRegistrationWithContext(ctx context.Context, createNotificationsRegistrationOptions *CreateNotificationsRegistrationOptions) (result *GetNotificationsSettings, response *core.DetailedResponse, err error)

CreateNotificationsRegistrationWithContext is an alternate form of the CreateNotificationsRegistration method which supports a Context parameter

func (*SecretsManagerV1) CreateSecret

func (secretsManager *SecretsManagerV1) CreateSecret(createSecretOptions *CreateSecretOptions) (result *CreateSecret, response *core.DetailedResponse, err error)

CreateSecret : Create a secret Create a secret or import an existing value that you can use to access or authenticate to a protected resource.

Use this method to either generate or import an existing secret, such as an arbitrary value or a TLS certificate, that you can manage in your Secrets Manager service instance. A successful request stores the secret in your dedicated instance based on the secret type and data that you specify. The response returns the ID value of the secret, along with other metadata.

To learn more about the types of secrets that you can create with Secrets Manager, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-what-is-secret).

func (*SecretsManagerV1) CreateSecretGroup

func (secretsManager *SecretsManagerV1) CreateSecretGroup(createSecretGroupOptions *CreateSecretGroupOptions) (result *SecretGroupDef, response *core.DetailedResponse, err error)

CreateSecretGroup : Create a secret group Create a secret group that you can use to organize secrets and control who on your team has access to them.

A successful request returns the ID value of the secret group, along with other metadata. To learn more about secret groups, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-groups).

func (*SecretsManagerV1) CreateSecretGroupWithContext

func (secretsManager *SecretsManagerV1) CreateSecretGroupWithContext(ctx context.Context, createSecretGroupOptions *CreateSecretGroupOptions) (result *SecretGroupDef, response *core.DetailedResponse, err error)

CreateSecretGroupWithContext is an alternate form of the CreateSecretGroup method which supports a Context parameter

func (*SecretsManagerV1) CreateSecretWithContext

func (secretsManager *SecretsManagerV1) CreateSecretWithContext(ctx context.Context, createSecretOptions *CreateSecretOptions) (result *CreateSecret, response *core.DetailedResponse, err error)

CreateSecretWithContext is an alternate form of the CreateSecret method which supports a Context parameter

func (*SecretsManagerV1) DeleteConfigElement added in v1.0.25

func (secretsManager *SecretsManagerV1) DeleteConfigElement(deleteConfigElementOptions *DeleteConfigElementOptions) (response *core.DetailedResponse, err error)

DeleteConfigElement : Delete a configuration Delete a configuration element from the specified secret type.

func (*SecretsManagerV1) DeleteConfigElementWithContext added in v1.0.25

func (secretsManager *SecretsManagerV1) DeleteConfigElementWithContext(ctx context.Context, deleteConfigElementOptions *DeleteConfigElementOptions) (response *core.DetailedResponse, err error)

DeleteConfigElementWithContext is an alternate form of the DeleteConfigElement method which supports a Context parameter

func (*SecretsManagerV1) DeleteNotificationsRegistration added in v1.0.28

func (secretsManager *SecretsManagerV1) DeleteNotificationsRegistration(deleteNotificationsRegistrationOptions *DeleteNotificationsRegistrationOptions) (response *core.DetailedResponse, err error)

DeleteNotificationsRegistration : Unregister from Event Notifications Delete a registration between a Secrets Manager instance and Event Notifications.

A successful request removes your Secrets Manager instance as a source in Event Notifications.

func (*SecretsManagerV1) DeleteNotificationsRegistrationWithContext added in v1.0.28

func (secretsManager *SecretsManagerV1) DeleteNotificationsRegistrationWithContext(ctx context.Context, deleteNotificationsRegistrationOptions *DeleteNotificationsRegistrationOptions) (response *core.DetailedResponse, err error)

DeleteNotificationsRegistrationWithContext is an alternate form of the DeleteNotificationsRegistration method which supports a Context parameter

func (*SecretsManagerV1) DeleteSecret

func (secretsManager *SecretsManagerV1) DeleteSecret(deleteSecretOptions *DeleteSecretOptions) (response *core.DetailedResponse, err error)

DeleteSecret : Delete a secret Delete a secret by specifying the ID of the secret.

func (*SecretsManagerV1) DeleteSecretGroup

func (secretsManager *SecretsManagerV1) DeleteSecretGroup(deleteSecretGroupOptions *DeleteSecretGroupOptions) (response *core.DetailedResponse, err error)

DeleteSecretGroup : Delete a secret group Delete a secret group by specifying the ID of the secret group.

**Note:** To delete a secret group, it must be empty. If you need to remove a secret group that contains secrets, you must first [delete the secrets](#delete-secret) that are associated with the group.

func (*SecretsManagerV1) DeleteSecretGroupWithContext

func (secretsManager *SecretsManagerV1) DeleteSecretGroupWithContext(ctx context.Context, deleteSecretGroupOptions *DeleteSecretGroupOptions) (response *core.DetailedResponse, err error)

DeleteSecretGroupWithContext is an alternate form of the DeleteSecretGroup method which supports a Context parameter

func (*SecretsManagerV1) DeleteSecretWithContext

func (secretsManager *SecretsManagerV1) DeleteSecretWithContext(ctx context.Context, deleteSecretOptions *DeleteSecretOptions) (response *core.DetailedResponse, err error)

DeleteSecretWithContext is an alternate form of the DeleteSecret method which supports a Context parameter

func (*SecretsManagerV1) DisableRetries

func (secretsManager *SecretsManagerV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*SecretsManagerV1) EnableRetries

func (secretsManager *SecretsManagerV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*SecretsManagerV1) GetConfig

func (secretsManager *SecretsManagerV1) GetConfig(getConfigOptions *GetConfigOptions) (result *GetConfig, response *core.DetailedResponse, err error)

GetConfig : Get the configuration of a secret type Get the configuration that is associated with the specified secret type.

func (*SecretsManagerV1) GetConfigElement added in v1.0.25

func (secretsManager *SecretsManagerV1) GetConfigElement(getConfigElementOptions *GetConfigElementOptions) (result *GetSingleConfigElement, response *core.DetailedResponse, err error)

GetConfigElement : Get a configuration Get the details of a specific configuration that is associated with a secret type.

func (*SecretsManagerV1) GetConfigElementWithContext added in v1.0.25

func (secretsManager *SecretsManagerV1) GetConfigElementWithContext(ctx context.Context, getConfigElementOptions *GetConfigElementOptions) (result *GetSingleConfigElement, response *core.DetailedResponse, err error)

GetConfigElementWithContext is an alternate form of the GetConfigElement method which supports a Context parameter

func (*SecretsManagerV1) GetConfigElements added in v1.0.25

func (secretsManager *SecretsManagerV1) GetConfigElements(getConfigElementsOptions *GetConfigElementsOptions) (result *GetConfigElements, response *core.DetailedResponse, err error)

GetConfigElements : List configurations List the configuration elements that are associated with a specified secret type.

func (*SecretsManagerV1) GetConfigElementsWithContext added in v1.0.25

func (secretsManager *SecretsManagerV1) GetConfigElementsWithContext(ctx context.Context, getConfigElementsOptions *GetConfigElementsOptions) (result *GetConfigElements, response *core.DetailedResponse, err error)

GetConfigElementsWithContext is an alternate form of the GetConfigElements method which supports a Context parameter

func (*SecretsManagerV1) GetConfigWithContext

func (secretsManager *SecretsManagerV1) GetConfigWithContext(ctx context.Context, getConfigOptions *GetConfigOptions) (result *GetConfig, response *core.DetailedResponse, err error)

GetConfigWithContext is an alternate form of the GetConfig method which supports a Context parameter

func (*SecretsManagerV1) GetEnableGzipCompression

func (secretsManager *SecretsManagerV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*SecretsManagerV1) GetLocks added in v1.0.45

func (secretsManager *SecretsManagerV1) GetLocks(getLocksOptions *GetLocksOptions) (result *ListSecretLocks, response *core.DetailedResponse, err error)

GetLocks : List secret locks List the locks that are associated with a specified secret.

func (*SecretsManagerV1) GetLocksWithContext added in v1.0.45

func (secretsManager *SecretsManagerV1) GetLocksWithContext(ctx context.Context, getLocksOptions *GetLocksOptions) (result *ListSecretLocks, response *core.DetailedResponse, err error)

GetLocksWithContext is an alternate form of the GetLocks method which supports a Context parameter

func (*SecretsManagerV1) GetNotificationsRegistration added in v1.0.28

func (secretsManager *SecretsManagerV1) GetNotificationsRegistration(getNotificationsRegistrationOptions *GetNotificationsRegistrationOptions) (result *GetNotificationsSettings, response *core.DetailedResponse, err error)

GetNotificationsRegistration : Get Event Notifications registration details Get the details of an existing registration between a Secrets Manager instance and Event Notifications.

func (*SecretsManagerV1) GetNotificationsRegistrationWithContext added in v1.0.28

func (secretsManager *SecretsManagerV1) GetNotificationsRegistrationWithContext(ctx context.Context, getNotificationsRegistrationOptions *GetNotificationsRegistrationOptions) (result *GetNotificationsSettings, response *core.DetailedResponse, err error)

GetNotificationsRegistrationWithContext is an alternate form of the GetNotificationsRegistration method which supports a Context parameter

func (*SecretsManagerV1) GetPolicy

func (secretsManager *SecretsManagerV1) GetPolicy(getPolicyOptions *GetPolicyOptions) (result GetSecretPoliciesIntf, response *core.DetailedResponse, err error)

GetPolicy : List secret policies List the rotation policies that are associated with a specified secret.

func (*SecretsManagerV1) GetPolicyWithContext

func (secretsManager *SecretsManagerV1) GetPolicyWithContext(ctx context.Context, getPolicyOptions *GetPolicyOptions) (result GetSecretPoliciesIntf, response *core.DetailedResponse, err error)

GetPolicyWithContext is an alternate form of the GetPolicy method which supports a Context parameter

func (*SecretsManagerV1) GetSecret

func (secretsManager *SecretsManagerV1) GetSecret(getSecretOptions *GetSecretOptions) (result *GetSecret, response *core.DetailedResponse, err error)

GetSecret : Get a secret Get a secret and its details by specifying the ID of the secret.

A successful request returns the secret data that is associated with your secret, along with other metadata. To view only the details of a specified secret without retrieving its value, use the [Get secret metadata](#get-secret-metadata) method.

func (*SecretsManagerV1) GetSecretGroup

func (secretsManager *SecretsManagerV1) GetSecretGroup(getSecretGroupOptions *GetSecretGroupOptions) (result *SecretGroupDef, response *core.DetailedResponse, err error)

GetSecretGroup : Get a secret group Get the metadata of an existing secret group by specifying the ID of the group.

func (*SecretsManagerV1) GetSecretGroupWithContext

func (secretsManager *SecretsManagerV1) GetSecretGroupWithContext(ctx context.Context, getSecretGroupOptions *GetSecretGroupOptions) (result *SecretGroupDef, response *core.DetailedResponse, err error)

GetSecretGroupWithContext is an alternate form of the GetSecretGroup method which supports a Context parameter

func (*SecretsManagerV1) GetSecretMetadata

func (secretsManager *SecretsManagerV1) GetSecretMetadata(getSecretMetadataOptions *GetSecretMetadataOptions) (result *SecretMetadataRequest, response *core.DetailedResponse, err error)

GetSecretMetadata : Get the metadata of a secret Get the details of a secret by specifying its ID.

A successful request returns only metadata about the secret, such as its name and creation date. To retrieve the value of a secret, use the [Get a secret](#get-secret) or [Get a version of a secret](#get-secret-version) methods.

func (*SecretsManagerV1) GetSecretMetadataWithContext

func (secretsManager *SecretsManagerV1) GetSecretMetadataWithContext(ctx context.Context, getSecretMetadataOptions *GetSecretMetadataOptions) (result *SecretMetadataRequest, response *core.DetailedResponse, err error)

GetSecretMetadataWithContext is an alternate form of the GetSecretMetadata method which supports a Context parameter

func (*SecretsManagerV1) GetSecretVersion added in v1.0.22

func (secretsManager *SecretsManagerV1) GetSecretVersion(getSecretVersionOptions *GetSecretVersionOptions) (result *GetSecretVersion, response *core.DetailedResponse, err error)

GetSecretVersion : Get a version of a secret Get a version of a secret by specifying the ID of the version or the alias `previous`.

A successful request returns the secret data that is associated with the specified version of your secret, along with other metadata.

func (*SecretsManagerV1) GetSecretVersionLocks added in v1.0.45

func (secretsManager *SecretsManagerV1) GetSecretVersionLocks(getSecretVersionLocksOptions *GetSecretVersionLocksOptions) (result *ListSecretLocks, response *core.DetailedResponse, err error)

GetSecretVersionLocks : List secret version locks List the locks that are associated with a specified secret version.

func (*SecretsManagerV1) GetSecretVersionLocksWithContext added in v1.0.45

func (secretsManager *SecretsManagerV1) GetSecretVersionLocksWithContext(ctx context.Context, getSecretVersionLocksOptions *GetSecretVersionLocksOptions) (result *ListSecretLocks, response *core.DetailedResponse, err error)

GetSecretVersionLocksWithContext is an alternate form of the GetSecretVersionLocks method which supports a Context parameter

func (*SecretsManagerV1) GetSecretVersionMetadata added in v1.0.22

func (secretsManager *SecretsManagerV1) GetSecretVersionMetadata(getSecretVersionMetadataOptions *GetSecretVersionMetadataOptions) (result *GetSecretVersionMetadata, response *core.DetailedResponse, err error)

GetSecretVersionMetadata : Get the metadata of a secret version Get the metadata of a secret version by specifying the ID of the version or the alias `previous`.

A successful request returns the metadata that is associated with the specified version of your secret.

func (*SecretsManagerV1) GetSecretVersionMetadataWithContext added in v1.0.22

func (secretsManager *SecretsManagerV1) GetSecretVersionMetadataWithContext(ctx context.Context, getSecretVersionMetadataOptions *GetSecretVersionMetadataOptions) (result *GetSecretVersionMetadata, response *core.DetailedResponse, err error)

GetSecretVersionMetadataWithContext is an alternate form of the GetSecretVersionMetadata method which supports a Context parameter

func (*SecretsManagerV1) GetSecretVersionWithContext added in v1.0.22

func (secretsManager *SecretsManagerV1) GetSecretVersionWithContext(ctx context.Context, getSecretVersionOptions *GetSecretVersionOptions) (result *GetSecretVersion, response *core.DetailedResponse, err error)

GetSecretVersionWithContext is an alternate form of the GetSecretVersion method which supports a Context parameter

func (*SecretsManagerV1) GetSecretWithContext

func (secretsManager *SecretsManagerV1) GetSecretWithContext(ctx context.Context, getSecretOptions *GetSecretOptions) (result *GetSecret, response *core.DetailedResponse, err error)

GetSecretWithContext is an alternate form of the GetSecret method which supports a Context parameter

func (*SecretsManagerV1) GetServiceURL

func (secretsManager *SecretsManagerV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*SecretsManagerV1) ListAllSecrets

func (secretsManager *SecretsManagerV1) ListAllSecrets(listAllSecretsOptions *ListAllSecretsOptions) (result *ListSecrets, response *core.DetailedResponse, err error)

ListAllSecrets : List all secrets List all of the secrets in your Secrets Manager instance.

func (*SecretsManagerV1) ListAllSecretsWithContext

func (secretsManager *SecretsManagerV1) ListAllSecretsWithContext(ctx context.Context, listAllSecretsOptions *ListAllSecretsOptions) (result *ListSecrets, response *core.DetailedResponse, err error)

ListAllSecretsWithContext is an alternate form of the ListAllSecrets method which supports a Context parameter

func (*SecretsManagerV1) ListInstanceSecretsLocks added in v1.0.45

func (secretsManager *SecretsManagerV1) ListInstanceSecretsLocks(listInstanceSecretsLocksOptions *ListInstanceSecretsLocksOptions) (result *GetInstanceLocks, response *core.DetailedResponse, err error)

ListInstanceSecretsLocks : List all secrets and locks List the lock details that are associated with all secrets in your Secrets Manager instance.

func (*SecretsManagerV1) ListInstanceSecretsLocksWithContext added in v1.0.45

func (secretsManager *SecretsManagerV1) ListInstanceSecretsLocksWithContext(ctx context.Context, listInstanceSecretsLocksOptions *ListInstanceSecretsLocksOptions) (result *GetInstanceLocks, response *core.DetailedResponse, err error)

ListInstanceSecretsLocksWithContext is an alternate form of the ListInstanceSecretsLocks method which supports a Context parameter

func (*SecretsManagerV1) ListSecretGroups

func (secretsManager *SecretsManagerV1) ListSecretGroups(listSecretGroupsOptions *ListSecretGroupsOptions) (result *SecretGroupDef, response *core.DetailedResponse, err error)

ListSecretGroups : List secret groups List the secret groups that are available in your Secrets Manager instance.

func (*SecretsManagerV1) ListSecretGroupsWithContext

func (secretsManager *SecretsManagerV1) ListSecretGroupsWithContext(ctx context.Context, listSecretGroupsOptions *ListSecretGroupsOptions) (result *SecretGroupDef, response *core.DetailedResponse, err error)

ListSecretGroupsWithContext is an alternate form of the ListSecretGroups method which supports a Context parameter

func (*SecretsManagerV1) ListSecretVersions added in v1.0.28

func (secretsManager *SecretsManagerV1) ListSecretVersions(listSecretVersionsOptions *ListSecretVersionsOptions) (result *ListSecretVersions, response *core.DetailedResponse, err error)

ListSecretVersions : List versions of a secret List the versions of a secret.

A successful request returns the list of the versions along with the metadata of each version.

func (*SecretsManagerV1) ListSecretVersionsWithContext added in v1.0.28

func (secretsManager *SecretsManagerV1) ListSecretVersionsWithContext(ctx context.Context, listSecretVersionsOptions *ListSecretVersionsOptions) (result *ListSecretVersions, response *core.DetailedResponse, err error)

ListSecretVersionsWithContext is an alternate form of the ListSecretVersions method which supports a Context parameter

func (*SecretsManagerV1) ListSecrets

func (secretsManager *SecretsManagerV1) ListSecrets(listSecretsOptions *ListSecretsOptions) (result *ListSecrets, response *core.DetailedResponse, err error)

ListSecrets : List secrets by type List the secrets in your Secrets Manager instance based on the type that you specify.

func (*SecretsManagerV1) ListSecretsWithContext

func (secretsManager *SecretsManagerV1) ListSecretsWithContext(ctx context.Context, listSecretsOptions *ListSecretsOptions) (result *ListSecrets, response *core.DetailedResponse, err error)

ListSecretsWithContext is an alternate form of the ListSecrets method which supports a Context parameter

func (*SecretsManagerV1) LockSecret added in v1.0.45

func (secretsManager *SecretsManagerV1) LockSecret(lockSecretOptions *LockSecretOptions) (result *GetSecretLocks, response *core.DetailedResponse, err error)

LockSecret : Lock a secret Create a lock on the current version of a secret.

A lock can be used to prevent a secret from being deleted or modified while it's in use by your applications. A successful request attaches a new lock to your secret, or replaces a lock of the same name if it already exists. Additionally, you can use this method to clear any matching locks on a secret by using one of the following optional lock modes:

- `exclusive`: Removes any other locks with matching names if they are found in the previous version of the secret. - `exclusive_delete`: Same as `exclusive`, but also permanently deletes the data of the previous secret version if it doesn't have any locks.

For more information about locking secrets, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-locks).

func (*SecretsManagerV1) LockSecretVersion added in v1.0.45

func (secretsManager *SecretsManagerV1) LockSecretVersion(lockSecretVersionOptions *LockSecretVersionOptions) (result *GetSecretLocks, response *core.DetailedResponse, err error)

LockSecretVersion : Lock a secret version Create a lock on the specified version of a secret.

A lock can be used to prevent a secret from being deleted or modified while it's in use by your applications. A successful request attaches a new lock to the specified version, or replaces a lock of the same name if it already exists. Additionally, you can use this method to clear any matching locks on a secret version by using one of the following optional lock modes:

- `exclusive`: Removes any other locks with matching names if they are found in the previous version of the secret. - `exclusive_delete`: Same as `exclusive`, but also permanently deletes the data of the previous secret version if it doesn't have any locks.

For more information about locking secrets, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-locks).

func (*SecretsManagerV1) LockSecretVersionWithContext added in v1.0.45

func (secretsManager *SecretsManagerV1) LockSecretVersionWithContext(ctx context.Context, lockSecretVersionOptions *LockSecretVersionOptions) (result *GetSecretLocks, response *core.DetailedResponse, err error)

LockSecretVersionWithContext is an alternate form of the LockSecretVersion method which supports a Context parameter

func (*SecretsManagerV1) LockSecretWithContext added in v1.0.45

func (secretsManager *SecretsManagerV1) LockSecretWithContext(ctx context.Context, lockSecretOptions *LockSecretOptions) (result *GetSecretLocks, response *core.DetailedResponse, err error)

LockSecretWithContext is an alternate form of the LockSecret method which supports a Context parameter

func (*SecretsManagerV1) NewActionOnConfigElementOptions added in v1.0.39

func (*SecretsManagerV1) NewActionOnConfigElementOptions(secretType string, configElement string, configName string, action string) *ActionOnConfigElementOptions

NewActionOnConfigElementOptions : Instantiate ActionOnConfigElementOptions

func (*SecretsManagerV1) NewArbitrarySecretMetadata added in v1.0.22

func (*SecretsManagerV1) NewArbitrarySecretMetadata(name string) (_model *ArbitrarySecretMetadata, err error)

NewArbitrarySecretMetadata : Instantiate ArbitrarySecretMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewArbitrarySecretResource added in v1.0.22

func (*SecretsManagerV1) NewArbitrarySecretResource(name string) (_model *ArbitrarySecretResource, err error)

NewArbitrarySecretResource : Instantiate ArbitrarySecretResource (Generic Model Constructor)

func (*SecretsManagerV1) NewCertificateSecretMetadata added in v1.0.22

func (*SecretsManagerV1) NewCertificateSecretMetadata(name string) (_model *CertificateSecretMetadata, err error)

NewCertificateSecretMetadata : Instantiate CertificateSecretMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewCertificateSecretResource added in v1.0.22

func (*SecretsManagerV1) NewCertificateSecretResource(name string) (_model *CertificateSecretResource, err error)

NewCertificateSecretResource : Instantiate CertificateSecretResource (Generic Model Constructor)

func (*SecretsManagerV1) NewCertificateTemplateConfig added in v1.0.39

func (*SecretsManagerV1) NewCertificateTemplateConfig(certificateAuthority string) (_model *CertificateTemplateConfig, err error)

NewCertificateTemplateConfig : Instantiate CertificateTemplateConfig (Generic Model Constructor)

func (*SecretsManagerV1) NewCollectionMetadata

func (*SecretsManagerV1) NewCollectionMetadata(collectionType string, collectionTotal int64) (_model *CollectionMetadata, err error)

NewCollectionMetadata : Instantiate CollectionMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewConfigElementDef added in v1.0.25

func (*SecretsManagerV1) NewConfigElementDef(name string, typeVar string, config ConfigElementDefConfigIntf) (_model *ConfigElementDef, err error)

NewConfigElementDef : Instantiate ConfigElementDef (Generic Model Constructor)

func (*SecretsManagerV1) NewConfigElementDefConfigClassicInfrastructureConfig added in v1.0.25

func (*SecretsManagerV1) NewConfigElementDefConfigClassicInfrastructureConfig(classicInfrastructureUsername string, classicInfrastructurePassword string) (_model *ConfigElementDefConfigClassicInfrastructureConfig, err error)

NewConfigElementDefConfigClassicInfrastructureConfig : Instantiate ConfigElementDefConfigClassicInfrastructureConfig (Generic Model Constructor)

func (*SecretsManagerV1) NewConfigElementDefConfigCloudInternetServicesConfig added in v1.0.25

func (*SecretsManagerV1) NewConfigElementDefConfigCloudInternetServicesConfig(cisCRN string) (_model *ConfigElementDefConfigCloudInternetServicesConfig, err error)

NewConfigElementDefConfigCloudInternetServicesConfig : Instantiate ConfigElementDefConfigCloudInternetServicesConfig (Generic Model Constructor)

func (*SecretsManagerV1) NewConfigElementDefConfigLetsEncryptConfig added in v1.0.25

func (*SecretsManagerV1) NewConfigElementDefConfigLetsEncryptConfig(privateKey string) (_model *ConfigElementDefConfigLetsEncryptConfig, err error)

NewConfigElementDefConfigLetsEncryptConfig : Instantiate ConfigElementDefConfigLetsEncryptConfig (Generic Model Constructor)

func (*SecretsManagerV1) NewCreateConfigElementOptions added in v1.0.25

func (*SecretsManagerV1) NewCreateConfigElementOptions(secretType string, configElement string, name string, typeVar string, config ConfigElementDefConfigIntf) *CreateConfigElementOptions

NewCreateConfigElementOptions : Instantiate CreateConfigElementOptions

func (*SecretsManagerV1) NewCreateIamCredentialsSecretEngineRootConfig added in v1.0.27

func (*SecretsManagerV1) NewCreateIamCredentialsSecretEngineRootConfig(apiKey string) (_model *CreateIamCredentialsSecretEngineRootConfig, err error)

NewCreateIamCredentialsSecretEngineRootConfig : Instantiate CreateIamCredentialsSecretEngineRootConfig (Generic Model Constructor)

func (*SecretsManagerV1) NewCreateNotificationsRegistrationOptions added in v1.0.28

func (*SecretsManagerV1) NewCreateNotificationsRegistrationOptions(eventNotificationsInstanceCRN string, eventNotificationsSourceName string) *CreateNotificationsRegistrationOptions

NewCreateNotificationsRegistrationOptions : Instantiate CreateNotificationsRegistrationOptions

func (*SecretsManagerV1) NewCreateSecret

func (*SecretsManagerV1) NewCreateSecret(metadata *CollectionMetadata, resources []SecretResourceIntf) (_model *CreateSecret, err error)

NewCreateSecret : Instantiate CreateSecret (Generic Model Constructor)

func (*SecretsManagerV1) NewCreateSecretGroupOptions

func (*SecretsManagerV1) NewCreateSecretGroupOptions(metadata *CollectionMetadata, resources []SecretGroupResource) *CreateSecretGroupOptions

NewCreateSecretGroupOptions : Instantiate CreateSecretGroupOptions

func (*SecretsManagerV1) NewCreateSecretOptions

func (*SecretsManagerV1) NewCreateSecretOptions(secretType string, metadata *CollectionMetadata, resources []SecretResourceIntf) *CreateSecretOptions

NewCreateSecretOptions : Instantiate CreateSecretOptions

func (*SecretsManagerV1) NewDeleteConfigElementOptions added in v1.0.25

func (*SecretsManagerV1) NewDeleteConfigElementOptions(secretType string, configElement string, configName string) *DeleteConfigElementOptions

NewDeleteConfigElementOptions : Instantiate DeleteConfigElementOptions

func (*SecretsManagerV1) NewDeleteNotificationsRegistrationOptions added in v1.0.28

func (*SecretsManagerV1) NewDeleteNotificationsRegistrationOptions() *DeleteNotificationsRegistrationOptions

NewDeleteNotificationsRegistrationOptions : Instantiate DeleteNotificationsRegistrationOptions

func (*SecretsManagerV1) NewDeleteSecretGroupOptions

func (*SecretsManagerV1) NewDeleteSecretGroupOptions(id string) *DeleteSecretGroupOptions

NewDeleteSecretGroupOptions : Instantiate DeleteSecretGroupOptions

func (*SecretsManagerV1) NewDeleteSecretOptions

func (*SecretsManagerV1) NewDeleteSecretOptions(secretType string, id string) *DeleteSecretOptions

NewDeleteSecretOptions : Instantiate DeleteSecretOptions

func (*SecretsManagerV1) NewGetConfigElementOptions added in v1.0.25

func (*SecretsManagerV1) NewGetConfigElementOptions(secretType string, configElement string, configName string) *GetConfigElementOptions

NewGetConfigElementOptions : Instantiate GetConfigElementOptions

func (*SecretsManagerV1) NewGetConfigElementsOptions added in v1.0.25

func (*SecretsManagerV1) NewGetConfigElementsOptions(secretType string, configElement string) *GetConfigElementsOptions

NewGetConfigElementsOptions : Instantiate GetConfigElementsOptions

func (*SecretsManagerV1) NewGetConfigOptions

func (*SecretsManagerV1) NewGetConfigOptions(secretType string) *GetConfigOptions

NewGetConfigOptions : Instantiate GetConfigOptions

func (*SecretsManagerV1) NewGetLocksOptions added in v1.0.45

func (*SecretsManagerV1) NewGetLocksOptions(secretType string, id string) *GetLocksOptions

NewGetLocksOptions : Instantiate GetLocksOptions

func (*SecretsManagerV1) NewGetNotificationsRegistrationOptions added in v1.0.28

func (*SecretsManagerV1) NewGetNotificationsRegistrationOptions() *GetNotificationsRegistrationOptions

NewGetNotificationsRegistrationOptions : Instantiate GetNotificationsRegistrationOptions

func (*SecretsManagerV1) NewGetPolicyOptions

func (*SecretsManagerV1) NewGetPolicyOptions(secretType string, id string) *GetPolicyOptions

NewGetPolicyOptions : Instantiate GetPolicyOptions

func (*SecretsManagerV1) NewGetSecretGroupOptions

func (*SecretsManagerV1) NewGetSecretGroupOptions(id string) *GetSecretGroupOptions

NewGetSecretGroupOptions : Instantiate GetSecretGroupOptions

func (*SecretsManagerV1) NewGetSecretMetadataOptions

func (*SecretsManagerV1) NewGetSecretMetadataOptions(secretType string, id string) *GetSecretMetadataOptions

NewGetSecretMetadataOptions : Instantiate GetSecretMetadataOptions

func (*SecretsManagerV1) NewGetSecretOptions

func (*SecretsManagerV1) NewGetSecretOptions(secretType string, id string) *GetSecretOptions

NewGetSecretOptions : Instantiate GetSecretOptions

func (*SecretsManagerV1) NewGetSecretVersionLocksOptions added in v1.0.45

func (*SecretsManagerV1) NewGetSecretVersionLocksOptions(secretType string, id string, versionID string) *GetSecretVersionLocksOptions

NewGetSecretVersionLocksOptions : Instantiate GetSecretVersionLocksOptions

func (*SecretsManagerV1) NewGetSecretVersionMetadataOptions added in v1.0.22

func (*SecretsManagerV1) NewGetSecretVersionMetadataOptions(secretType string, id string, versionID string) *GetSecretVersionMetadataOptions

NewGetSecretVersionMetadataOptions : Instantiate GetSecretVersionMetadataOptions

func (*SecretsManagerV1) NewGetSecretVersionOptions added in v1.0.22

func (*SecretsManagerV1) NewGetSecretVersionOptions(secretType string, id string, versionID string) *GetSecretVersionOptions

NewGetSecretVersionOptions : Instantiate GetSecretVersionOptions

func (*SecretsManagerV1) NewIamCredentialsSecretMetadata added in v1.0.22

func (*SecretsManagerV1) NewIamCredentialsSecretMetadata(name string) (_model *IamCredentialsSecretMetadata, err error)

NewIamCredentialsSecretMetadata : Instantiate IamCredentialsSecretMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewIamCredentialsSecretResource added in v1.0.22

func (*SecretsManagerV1) NewIamCredentialsSecretResource(name string) (_model *IamCredentialsSecretResource, err error)

NewIamCredentialsSecretResource : Instantiate IamCredentialsSecretResource (Generic Model Constructor)

func (*SecretsManagerV1) NewIntermediateCertificateAuthorityConfig added in v1.0.39

func (*SecretsManagerV1) NewIntermediateCertificateAuthorityConfig(maxTTL interface{}, signingMethod string, commonName string) (_model *IntermediateCertificateAuthorityConfig, err error)

NewIntermediateCertificateAuthorityConfig : Instantiate IntermediateCertificateAuthorityConfig (Generic Model Constructor)

func (*SecretsManagerV1) NewKvSecretMetadata added in v1.0.30

func (*SecretsManagerV1) NewKvSecretMetadata(name string) (_model *KvSecretMetadata, err error)

NewKvSecretMetadata : Instantiate KvSecretMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewKvSecretResource added in v1.0.30

func (*SecretsManagerV1) NewKvSecretResource(name string) (_model *KvSecretResource, err error)

NewKvSecretResource : Instantiate KvSecretResource (Generic Model Constructor)

func (*SecretsManagerV1) NewListAllSecretsOptions

func (*SecretsManagerV1) NewListAllSecretsOptions() *ListAllSecretsOptions

NewListAllSecretsOptions : Instantiate ListAllSecretsOptions

func (*SecretsManagerV1) NewListInstanceSecretsLocksOptions added in v1.0.45

func (*SecretsManagerV1) NewListInstanceSecretsLocksOptions() *ListInstanceSecretsLocksOptions

NewListInstanceSecretsLocksOptions : Instantiate ListInstanceSecretsLocksOptions

func (*SecretsManagerV1) NewListSecretGroupsOptions

func (*SecretsManagerV1) NewListSecretGroupsOptions() *ListSecretGroupsOptions

NewListSecretGroupsOptions : Instantiate ListSecretGroupsOptions

func (*SecretsManagerV1) NewListSecretVersionsOptions added in v1.0.28

func (*SecretsManagerV1) NewListSecretVersionsOptions(secretType string, id string) *ListSecretVersionsOptions

NewListSecretVersionsOptions : Instantiate ListSecretVersionsOptions

func (*SecretsManagerV1) NewListSecretsOptions

func (*SecretsManagerV1) NewListSecretsOptions(secretType string) *ListSecretsOptions

NewListSecretsOptions : Instantiate ListSecretsOptions

func (*SecretsManagerV1) NewLockSecretBodyLocksItem added in v1.0.45

func (*SecretsManagerV1) NewLockSecretBodyLocksItem(name string) (_model *LockSecretBodyLocksItem, err error)

NewLockSecretBodyLocksItem : Instantiate LockSecretBodyLocksItem (Generic Model Constructor)

func (*SecretsManagerV1) NewLockSecretOptions added in v1.0.45

func (*SecretsManagerV1) NewLockSecretOptions(secretType string, id string) *LockSecretOptions

NewLockSecretOptions : Instantiate LockSecretOptions

func (*SecretsManagerV1) NewLockSecretVersionOptions added in v1.0.45

func (*SecretsManagerV1) NewLockSecretVersionOptions(secretType string, id string, versionID string) *LockSecretVersionOptions

NewLockSecretVersionOptions : Instantiate LockSecretVersionOptions

func (*SecretsManagerV1) NewPrivateCertPolicyRotation added in v1.0.39

func (*SecretsManagerV1) NewPrivateCertPolicyRotation(autoRotate bool) (_model *PrivateCertPolicyRotation, err error)

NewPrivateCertPolicyRotation : Instantiate PrivateCertPolicyRotation (Generic Model Constructor)

func (*SecretsManagerV1) NewPrivateCertificateSecretMetadata added in v1.0.37

func (*SecretsManagerV1) NewPrivateCertificateSecretMetadata(name string) (_model *PrivateCertificateSecretMetadata, err error)

NewPrivateCertificateSecretMetadata : Instantiate PrivateCertificateSecretMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewPrivateCertificateSecretResource added in v1.0.39

func (*SecretsManagerV1) NewPrivateCertificateSecretResource(name string, certificateTemplate string, commonName string) (_model *PrivateCertificateSecretResource, err error)

NewPrivateCertificateSecretResource : Instantiate PrivateCertificateSecretResource (Generic Model Constructor)

func (*SecretsManagerV1) NewPublicCertificateSecretMetadata added in v1.0.28

func (*SecretsManagerV1) NewPublicCertificateSecretMetadata(name string) (_model *PublicCertificateSecretMetadata, err error)

NewPublicCertificateSecretMetadata : Instantiate PublicCertificateSecretMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewPublicCertificateSecretResource added in v1.0.25

func (*SecretsManagerV1) NewPublicCertificateSecretResource(name string) (_model *PublicCertificateSecretResource, err error)

NewPublicCertificateSecretResource : Instantiate PublicCertificateSecretResource (Generic Model Constructor)

func (*SecretsManagerV1) NewPutConfigOptions

func (*SecretsManagerV1) NewPutConfigOptions(secretType string, engineConfig EngineConfigIntf) *PutConfigOptions

NewPutConfigOptions : Instantiate PutConfigOptions

func (*SecretsManagerV1) NewPutPolicyOptions

func (*SecretsManagerV1) NewPutPolicyOptions(secretType string, id string, metadata *CollectionMetadata, resources []SecretPolicyRotation) *PutPolicyOptions

NewPutPolicyOptions : Instantiate PutPolicyOptions

func (*SecretsManagerV1) NewRestoreIamCredentialsSecretBody added in v1.0.28

func (*SecretsManagerV1) NewRestoreIamCredentialsSecretBody(versionID string) (_model *RestoreIamCredentialsSecretBody, err error)

NewRestoreIamCredentialsSecretBody : Instantiate RestoreIamCredentialsSecretBody (Generic Model Constructor)

func (*SecretsManagerV1) NewRevokeAction added in v1.0.39

func (*SecretsManagerV1) NewRevokeAction(serialNumber string) (_model *RevokeAction, err error)

NewRevokeAction : Instantiate RevokeAction (Generic Model Constructor)

func (*SecretsManagerV1) NewRootCertificateAuthorityConfig added in v1.0.39

func (*SecretsManagerV1) NewRootCertificateAuthorityConfig(maxTTL interface{}, commonName string) (_model *RootCertificateAuthorityConfig, err error)

NewRootCertificateAuthorityConfig : Instantiate RootCertificateAuthorityConfig (Generic Model Constructor)

func (*SecretsManagerV1) NewRotateArbitrarySecretBody added in v1.0.22

func (*SecretsManagerV1) NewRotateArbitrarySecretBody(payload string) (_model *RotateArbitrarySecretBody, err error)

NewRotateArbitrarySecretBody : Instantiate RotateArbitrarySecretBody (Generic Model Constructor)

func (*SecretsManagerV1) NewRotateCertificateBody added in v1.0.22

func (*SecretsManagerV1) NewRotateCertificateBody(certificate string) (_model *RotateCertificateBody, err error)

NewRotateCertificateBody : Instantiate RotateCertificateBody (Generic Model Constructor)

func (*SecretsManagerV1) NewRotateKvSecretBody added in v1.0.30

func (*SecretsManagerV1) NewRotateKvSecretBody(payload map[string]interface{}) (_model *RotateKvSecretBody, err error)

NewRotateKvSecretBody : Instantiate RotateKvSecretBody (Generic Model Constructor)

func (*SecretsManagerV1) NewRotatePrivateCertBody added in v1.0.46

func (*SecretsManagerV1) NewRotatePrivateCertBody(customMetadata map[string]interface{}) (_model *RotatePrivateCertBody, err error)

NewRotatePrivateCertBody : Instantiate RotatePrivateCertBody (Generic Model Constructor)

func (*SecretsManagerV1) NewRotatePrivateCertBodyWithCsr added in v1.0.48

func (*SecretsManagerV1) NewRotatePrivateCertBodyWithCsr(csr string) (_model *RotatePrivateCertBodyWithCsr, err error)

NewRotatePrivateCertBodyWithCsr : Instantiate RotatePrivateCertBodyWithCsr (Generic Model Constructor)

func (*SecretsManagerV1) NewRotatePrivateCertBodyWithVersionCustomMetadata added in v1.0.46

func (*SecretsManagerV1) NewRotatePrivateCertBodyWithVersionCustomMetadata(versionCustomMetadata map[string]interface{}) (_model *RotatePrivateCertBodyWithVersionCustomMetadata, err error)

NewRotatePrivateCertBodyWithVersionCustomMetadata : Instantiate RotatePrivateCertBodyWithVersionCustomMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewRotatePublicCertBody added in v1.0.25

func (*SecretsManagerV1) NewRotatePublicCertBody(rotateKeys bool) (_model *RotatePublicCertBody, err error)

NewRotatePublicCertBody : Instantiate RotatePublicCertBody (Generic Model Constructor)

func (*SecretsManagerV1) NewRotateUsernamePasswordSecretBody added in v1.0.22

func (*SecretsManagerV1) NewRotateUsernamePasswordSecretBody(password string) (_model *RotateUsernamePasswordSecretBody, err error)

NewRotateUsernamePasswordSecretBody : Instantiate RotateUsernamePasswordSecretBody (Generic Model Constructor)

func (*SecretsManagerV1) NewSecretGroupDef

func (*SecretsManagerV1) NewSecretGroupDef(metadata *CollectionMetadata, resources []SecretGroupResource) (_model *SecretGroupDef, err error)

NewSecretGroupDef : Instantiate SecretGroupDef (Generic Model Constructor)

func (*SecretsManagerV1) NewSecretMetadataRequest

func (*SecretsManagerV1) NewSecretMetadataRequest(metadata *CollectionMetadata, resources []SecretMetadataIntf) (_model *SecretMetadataRequest, err error)

NewSecretMetadataRequest : Instantiate SecretMetadataRequest (Generic Model Constructor)

func (*SecretsManagerV1) NewSecretPolicyRotation

func (*SecretsManagerV1) NewSecretPolicyRotation(typeVar string, rotation SecretPolicyRotationRotationIntf) (_model *SecretPolicyRotation, err error)

NewSecretPolicyRotation : Instantiate SecretPolicyRotation (Generic Model Constructor)

func (*SecretsManagerV1) NewSecretPolicyRotationRotationPolicyRotation added in v1.0.25

func (*SecretsManagerV1) NewSecretPolicyRotationRotationPolicyRotation(interval int64, unit string) (_model *SecretPolicyRotationRotationPolicyRotation, err error)

NewSecretPolicyRotationRotationPolicyRotation : Instantiate SecretPolicyRotationRotationPolicyRotation (Generic Model Constructor)

func (*SecretsManagerV1) NewSecretPolicyRotationRotationPublicCertPolicyRotation added in v1.0.25

func (*SecretsManagerV1) NewSecretPolicyRotationRotationPublicCertPolicyRotation(autoRotate bool, rotateKeys bool) (_model *SecretPolicyRotationRotationPublicCertPolicyRotation, err error)

NewSecretPolicyRotationRotationPublicCertPolicyRotation : Instantiate SecretPolicyRotationRotationPublicCertPolicyRotation (Generic Model Constructor)

func (*SecretsManagerV1) NewSendTestNotificationOptions added in v1.0.37

func (*SecretsManagerV1) NewSendTestNotificationOptions() *SendTestNotificationOptions

NewSendTestNotificationOptions : Instantiate SendTestNotificationOptions

func (*SecretsManagerV1) NewSetSignedAction added in v1.0.39

func (*SecretsManagerV1) NewSetSignedAction(certificate string) (_model *SetSignedAction, err error)

NewSetSignedAction : Instantiate SetSignedAction (Generic Model Constructor)

func (*SecretsManagerV1) NewSignCsrAction added in v1.0.39

func (*SecretsManagerV1) NewSignCsrAction(csr string) (_model *SignCsrAction, err error)

NewSignCsrAction : Instantiate SignCsrAction (Generic Model Constructor)

func (*SecretsManagerV1) NewSignIntermediateAction added in v1.0.39

func (*SecretsManagerV1) NewSignIntermediateAction(intermediateCertificateAuthority string) (_model *SignIntermediateAction, err error)

NewSignIntermediateAction : Instantiate SignIntermediateAction (Generic Model Constructor)

func (*SecretsManagerV1) NewUnlockSecretOptions added in v1.0.45

func (*SecretsManagerV1) NewUnlockSecretOptions(secretType string, id string) *UnlockSecretOptions

NewUnlockSecretOptions : Instantiate UnlockSecretOptions

func (*SecretsManagerV1) NewUnlockSecretVersionOptions added in v1.0.45

func (*SecretsManagerV1) NewUnlockSecretVersionOptions(secretType string, id string, versionID string) *UnlockSecretVersionOptions

NewUnlockSecretVersionOptions : Instantiate UnlockSecretVersionOptions

func (*SecretsManagerV1) NewUpdateConfigElementOptions added in v1.0.25

func (*SecretsManagerV1) NewUpdateConfigElementOptions(secretType string, configElement string, configName string, typeVar string, config map[string]interface{}) *UpdateConfigElementOptions

NewUpdateConfigElementOptions : Instantiate UpdateConfigElementOptions

func (*SecretsManagerV1) NewUpdateSecretGroupMetadataOptions

func (*SecretsManagerV1) NewUpdateSecretGroupMetadataOptions(id string, metadata *CollectionMetadata, resources []SecretGroupMetadataUpdatable) *UpdateSecretGroupMetadataOptions

NewUpdateSecretGroupMetadataOptions : Instantiate UpdateSecretGroupMetadataOptions

func (*SecretsManagerV1) NewUpdateSecretMetadataOptions

func (*SecretsManagerV1) NewUpdateSecretMetadataOptions(secretType string, id string, metadata *CollectionMetadata, resources []SecretMetadataIntf) *UpdateSecretMetadataOptions

NewUpdateSecretMetadataOptions : Instantiate UpdateSecretMetadataOptions

func (*SecretsManagerV1) NewUpdateSecretOptions

func (*SecretsManagerV1) NewUpdateSecretOptions(secretType string, id string, action string) *UpdateSecretOptions

NewUpdateSecretOptions : Instantiate UpdateSecretOptions

func (*SecretsManagerV1) NewUpdateSecretVersionMetadataOptions added in v1.0.46

func (*SecretsManagerV1) NewUpdateSecretVersionMetadataOptions(secretType string, id string, versionID string, metadata *CollectionMetadata, resources []UpdateSecretVersionMetadata) *UpdateSecretVersionMetadataOptions

NewUpdateSecretVersionMetadataOptions : Instantiate UpdateSecretVersionMetadataOptions

func (*SecretsManagerV1) NewUpdateSecretVersionOptions added in v1.0.39

func (*SecretsManagerV1) NewUpdateSecretVersionOptions(secretType string, id string, versionID string, action string) *UpdateSecretVersionOptions

NewUpdateSecretVersionOptions : Instantiate UpdateSecretVersionOptions

func (*SecretsManagerV1) NewUsernamePasswordSecretMetadata added in v1.0.22

func (*SecretsManagerV1) NewUsernamePasswordSecretMetadata(name string) (_model *UsernamePasswordSecretMetadata, err error)

NewUsernamePasswordSecretMetadata : Instantiate UsernamePasswordSecretMetadata (Generic Model Constructor)

func (*SecretsManagerV1) NewUsernamePasswordSecretResource added in v1.0.22

func (*SecretsManagerV1) NewUsernamePasswordSecretResource(name string) (_model *UsernamePasswordSecretResource, err error)

NewUsernamePasswordSecretResource : Instantiate UsernamePasswordSecretResource (Generic Model Constructor)

func (*SecretsManagerV1) PutConfig

func (secretsManager *SecretsManagerV1) PutConfig(putConfigOptions *PutConfigOptions) (response *core.DetailedResponse, err error)

PutConfig : Set the configuration of a secret type Set the configuration for the specified secret type.

Use this method to configure the IAM credentials (`iam_credentials`) engine for your service instance. Looking to order or generate certificates? To configure the public certificates (`public_cert`) or private certificates (`private_cert`) engines, use the [Add a configuration](#create_config_element) method.

func (*SecretsManagerV1) PutConfigWithContext

func (secretsManager *SecretsManagerV1) PutConfigWithContext(ctx context.Context, putConfigOptions *PutConfigOptions) (response *core.DetailedResponse, err error)

PutConfigWithContext is an alternate form of the PutConfig method which supports a Context parameter

func (*SecretsManagerV1) PutPolicy

func (secretsManager *SecretsManagerV1) PutPolicy(putPolicyOptions *PutPolicyOptions) (result GetSecretPoliciesIntf, response *core.DetailedResponse, err error)

PutPolicy : Set secret policies Create or update one or more policies, such as an [automatic rotation policy](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-automatic-rotation), for the specified secret. To remove a policy, keep the resources block empty.

func (*SecretsManagerV1) PutPolicyWithContext

func (secretsManager *SecretsManagerV1) PutPolicyWithContext(ctx context.Context, putPolicyOptions *PutPolicyOptions) (result GetSecretPoliciesIntf, response *core.DetailedResponse, err error)

PutPolicyWithContext is an alternate form of the PutPolicy method which supports a Context parameter

func (*SecretsManagerV1) SendTestNotification added in v1.0.37

func (secretsManager *SecretsManagerV1) SendTestNotification(sendTestNotificationOptions *SendTestNotificationOptions) (response *core.DetailedResponse, err error)

SendTestNotification : Send a test event Send a test event from a Secrets Manager instance to a configured [Event Notifications](https://cloud.ibm.com/apidocs/event-notifications) instance.

A successful request sends a test event to the Event Notifications instance. For more information about enabling notifications for Secrets Manager, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-event-notifications).

func (*SecretsManagerV1) SendTestNotificationWithContext added in v1.0.37

func (secretsManager *SecretsManagerV1) SendTestNotificationWithContext(ctx context.Context, sendTestNotificationOptions *SendTestNotificationOptions) (response *core.DetailedResponse, err error)

SendTestNotificationWithContext is an alternate form of the SendTestNotification method which supports a Context parameter

func (*SecretsManagerV1) SetDefaultHeaders

func (secretsManager *SecretsManagerV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*SecretsManagerV1) SetEnableGzipCompression

func (secretsManager *SecretsManagerV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*SecretsManagerV1) SetServiceURL

func (secretsManager *SecretsManagerV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*SecretsManagerV1) UnlockSecret added in v1.0.45

func (secretsManager *SecretsManagerV1) UnlockSecret(unlockSecretOptions *UnlockSecretOptions) (result *GetSecretLocks, response *core.DetailedResponse, err error)

UnlockSecret : Unlock a secret Delete one or more locks that are associated with the current version of a secret.

A successful request deletes the locks that you specify. To remove all locks, you can pass `{"locks": ["*"]}` in in the request body. Otherwise, specify the names of the locks that you want to delete. For example, `{"locks": ["lock1", "lock2"]}`.

**Note:** A secret is considered unlocked and able to be revoked or deleted only after all of its locks are removed. To understand whether a secret contains locks, check the `locks_total` field that is returned as part of the metadata of your secret.

func (*SecretsManagerV1) UnlockSecretVersion added in v1.0.45

func (secretsManager *SecretsManagerV1) UnlockSecretVersion(unlockSecretVersionOptions *UnlockSecretVersionOptions) (result *GetSecretLocks, response *core.DetailedResponse, err error)

UnlockSecretVersion : Unlock a secret version Delete one or more locks that are associated with the specified secret version.

A successful request deletes the locks that you specify. To remove all locks, you can pass `{"locks": ["*"]}` in in the request body. Otherwise, specify the names of the locks that you want to delete. For example, `{"locks": ["lock-1", "lock-2"]}`.

**Note:** A secret is considered unlocked and able to be revoked or deleted only after all of its locks are removed. To understand whether a secret contains locks, check the `locks_total` field that is returned as part of the metadata of your secret.

func (*SecretsManagerV1) UnlockSecretVersionWithContext added in v1.0.45

func (secretsManager *SecretsManagerV1) UnlockSecretVersionWithContext(ctx context.Context, unlockSecretVersionOptions *UnlockSecretVersionOptions) (result *GetSecretLocks, response *core.DetailedResponse, err error)

UnlockSecretVersionWithContext is an alternate form of the UnlockSecretVersion method which supports a Context parameter

func (*SecretsManagerV1) UnlockSecretWithContext added in v1.0.45

func (secretsManager *SecretsManagerV1) UnlockSecretWithContext(ctx context.Context, unlockSecretOptions *UnlockSecretOptions) (result *GetSecretLocks, response *core.DetailedResponse, err error)

UnlockSecretWithContext is an alternate form of the UnlockSecret method which supports a Context parameter

func (*SecretsManagerV1) UpdateConfigElement added in v1.0.25

func (secretsManager *SecretsManagerV1) UpdateConfigElement(updateConfigElementOptions *UpdateConfigElementOptions) (result *GetSingleConfigElement, response *core.DetailedResponse, err error)

UpdateConfigElement : Update a configuration Update a configuration element that is associated with the specified secret type.

func (*SecretsManagerV1) UpdateConfigElementWithContext added in v1.0.25

func (secretsManager *SecretsManagerV1) UpdateConfigElementWithContext(ctx context.Context, updateConfigElementOptions *UpdateConfigElementOptions) (result *GetSingleConfigElement, response *core.DetailedResponse, err error)

UpdateConfigElementWithContext is an alternate form of the UpdateConfigElement method which supports a Context parameter

func (*SecretsManagerV1) UpdateSecret

func (secretsManager *SecretsManagerV1) UpdateSecret(updateSecretOptions *UpdateSecretOptions) (result *GetSecret, response *core.DetailedResponse, err error)

UpdateSecret : Invoke an action on a secret Invoke an action on a specified secret. This method supports the following actions:

- `rotate`: Replace the value of a secret. - `restore`: Restore a previous version of an `iam_credentials` secret. - `revoke`: Revoke a private certificate. - `delete_credentials`: Delete the API key that is associated with an `iam_credentials` secret. - `validate_dns_challenge`: Validate challenges for a public certificate that is ordered with a manual DNS provider.

func (*SecretsManagerV1) UpdateSecretGroupMetadata

func (secretsManager *SecretsManagerV1) UpdateSecretGroupMetadata(updateSecretGroupMetadataOptions *UpdateSecretGroupMetadataOptions) (result *SecretGroupDef, response *core.DetailedResponse, err error)

UpdateSecretGroupMetadata : Update a secret group Update the metadata of an existing secret group, such as its name or description.

func (*SecretsManagerV1) UpdateSecretGroupMetadataWithContext

func (secretsManager *SecretsManagerV1) UpdateSecretGroupMetadataWithContext(ctx context.Context, updateSecretGroupMetadataOptions *UpdateSecretGroupMetadataOptions) (result *SecretGroupDef, response *core.DetailedResponse, err error)

UpdateSecretGroupMetadataWithContext is an alternate form of the UpdateSecretGroupMetadata method which supports a Context parameter

func (*SecretsManagerV1) UpdateSecretMetadata

func (secretsManager *SecretsManagerV1) UpdateSecretMetadata(updateSecretMetadataOptions *UpdateSecretMetadataOptions) (result *SecretMetadataRequest, response *core.DetailedResponse, err error)

UpdateSecretMetadata : Update secret metadata Update the metadata of a secret, such as its name or description.

To update the actual contents of a secret, rotate the secret by using the [Invoke an action on a secret](#update-secret) method.

func (*SecretsManagerV1) UpdateSecretMetadataWithContext

func (secretsManager *SecretsManagerV1) UpdateSecretMetadataWithContext(ctx context.Context, updateSecretMetadataOptions *UpdateSecretMetadataOptions) (result *SecretMetadataRequest, response *core.DetailedResponse, err error)

UpdateSecretMetadataWithContext is an alternate form of the UpdateSecretMetadata method which supports a Context parameter

func (*SecretsManagerV1) UpdateSecretVersion added in v1.0.39

func (secretsManager *SecretsManagerV1) UpdateSecretVersion(updateSecretVersionOptions *UpdateSecretVersionOptions) (result *GetSecret, response *core.DetailedResponse, err error)

UpdateSecretVersion : Invoke an action on a version of a secret Invoke an action on a specified version of a secret. This method supports the following actions:

- `revoke`: Revoke a version of a private certificate.

func (*SecretsManagerV1) UpdateSecretVersionMetadata added in v1.0.46

func (secretsManager *SecretsManagerV1) UpdateSecretVersionMetadata(updateSecretVersionMetadataOptions *UpdateSecretVersionMetadataOptions) (result *GetSecretVersionMetadata, response *core.DetailedResponse, err error)

UpdateSecretVersionMetadata : Update the metadata of a secret version Update the metadata of a secret version, such as `version_custom_metadata`.

func (*SecretsManagerV1) UpdateSecretVersionMetadataWithContext added in v1.0.46

func (secretsManager *SecretsManagerV1) UpdateSecretVersionMetadataWithContext(ctx context.Context, updateSecretVersionMetadataOptions *UpdateSecretVersionMetadataOptions) (result *GetSecretVersionMetadata, response *core.DetailedResponse, err error)

UpdateSecretVersionMetadataWithContext is an alternate form of the UpdateSecretVersionMetadata method which supports a Context parameter

func (*SecretsManagerV1) UpdateSecretVersionWithContext added in v1.0.39

func (secretsManager *SecretsManagerV1) UpdateSecretVersionWithContext(ctx context.Context, updateSecretVersionOptions *UpdateSecretVersionOptions) (result *GetSecret, response *core.DetailedResponse, err error)

UpdateSecretVersionWithContext is an alternate form of the UpdateSecretVersion method which supports a Context parameter

func (*SecretsManagerV1) UpdateSecretWithContext

func (secretsManager *SecretsManagerV1) UpdateSecretWithContext(ctx context.Context, updateSecretOptions *UpdateSecretOptions) (result *GetSecret, response *core.DetailedResponse, err error)

UpdateSecretWithContext is an alternate form of the UpdateSecret method which supports a Context parameter

type SecretsManagerV1Options

type SecretsManagerV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

SecretsManagerV1Options : Service options

type SendTestNotificationOptions added in v1.0.37

type SendTestNotificationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

SendTestNotificationOptions : The SendTestNotification options.

func (*SendTestNotificationOptions) SetHeaders added in v1.0.37

func (options *SendTestNotificationOptions) SetHeaders(param map[string]string) *SendTestNotificationOptions

SetHeaders : Allow user to set Headers

type SetSignedAction added in v1.0.39

type SetSignedAction struct {
	// The PEM-encoded certificate.
	Certificate *string `json:"certificate" validate:"required"`
}

SetSignedAction : A request to set a signed certificate in an intermediate certificate authority. This model "extends" ConfigAction

type SetSignedActionResult added in v1.0.39

type SetSignedActionResult struct {
}

SetSignedActionResult : Properties that are returned with a successful `set_signed` action. This model "extends" ConfigElementActionResultConfig

type SignActionResultData added in v1.0.39

type SignActionResultData struct {
	// The PEM-encoded certificate.
	Certificate *string `json:"certificate,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The PEM-encoded certificate of the certificate authority that signed and issued this certificate.
	IssuingCa *string `json:"issuing_ca,omitempty"`

	// The chain of certificate authorities that are associated with the certificate.
	CaChain []string `json:"ca_chain,omitempty"`

	// The time until the certificate expires.
	Expiration *int64 `json:"expiration,omitempty"`
}

SignActionResultData : Properties that are returned with a successful `sign` action.

type SignCsrAction added in v1.0.39

type SignCsrAction struct {
	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to a private certificate.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `12h`. The value can't exceed
	// the `max_ttl` that is defined in the associated certificate template.
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The maximum path length to encode in the generated certificate. `-1` means no limit.
	//
	// If the signing certificate has a maximum path length set, the path length is set to one less than that of the
	// signing certificate. A limit of `0` means a literal path length of zero.
	MaxPathLength *int64 `json:"max_path_length,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The allowed DNS domains or subdomains for the certificates to be signed and issued by this CA certificate.
	PermittedDNSDomains []string `json:"permitted_dns_domains,omitempty"`

	// Determines whether to use values from a certificate signing request (CSR) to complete a `sign_csr` action. If set to
	// `true`, then:
	//
	// 1) Subject information, including names and alternate names, are preserved from the CSR rather than using the values
	// provided in the other parameters to this operation.
	//
	// 2) Any key usages (for example, non-repudiation) that are requested in the CSR are added to the basic set of key
	// usages used for CA certs signed by this intermediate authority.
	//
	// 3) Extensions that are requested in the CSR are copied into the issued private certificate.
	UseCsrValues *bool `json:"use_csr_values,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The PEM-encoded certificate signing request (CSR). This field is required for the `sign_csr` action.
	Csr *string `json:"csr" validate:"required"`
}

SignCsrAction : A request to sign a certificate signing request (CSR). This model "extends" ConfigAction

type SignCsrActionResult added in v1.0.39

type SignCsrActionResult struct {
	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to a private certificate.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `12h`. The value can't exceed
	// the `max_ttl` that is defined in the associated certificate template.
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The maximum path length to encode in the generated certificate. `-1` means no limit.
	//
	// If the signing certificate has a maximum path length set, the path length is set to one less than that of the
	// signing certificate. A limit of `0` means a literal path length of zero.
	MaxPathLength *int64 `json:"max_path_length,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The allowed DNS domains or subdomains for the certificates to be signed and issued by this CA certificate.
	PermittedDNSDomains []string `json:"permitted_dns_domains,omitempty"`

	// Determines whether to use values from a certificate signing request (CSR) to complete a `sign_csr` action. If set to
	// `true`, then:
	//
	// 1) Subject information, including names and alternate names, are preserved from the CSR rather than using the values
	// provided in the other parameters to this operation.
	//
	// 2) Any key usages (for example, non-repudiation) that are requested in the CSR are added to the basic set of key
	// usages used for CA certs signed by this intermediate authority.
	//
	// 3) Extensions that are requested in the CSR are copied into the issued private certificate.
	UseCsrValues *bool `json:"use_csr_values,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Properties that are returned with a successful `sign` action.
	Data *SignActionResultData `json:"data,omitempty"`

	// The PEM-encoded certificate signing request (CSR).
	Csr *string `json:"csr" validate:"required"`
}

SignCsrActionResult : Properties that are returned with a successful `sign_csr` action. This model "extends" ConfigElementActionResultConfig

type SignIntermediateAction added in v1.0.39

type SignIntermediateAction struct {
	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to a private certificate.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `12h`. The value can't exceed
	// the `max_ttl` that is defined in the associated certificate template.
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The maximum path length to encode in the generated certificate. `-1` means no limit.
	//
	// If the signing certificate has a maximum path length set, the path length is set to one less than that of the
	// signing certificate. A limit of `0` means a literal path length of zero.
	MaxPathLength *int64 `json:"max_path_length,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The allowed DNS domains or subdomains for the certificates to be signed and issued by this CA certificate.
	PermittedDNSDomains []string `json:"permitted_dns_domains,omitempty"`

	// Determines whether to use values from a certificate signing request (CSR) to complete a `sign_csr` action. If set to
	// `true`, then:
	//
	// 1) Subject information, including names and alternate names, are preserved from the CSR rather than using the values
	// provided in the other parameters to this operation.
	//
	// 2) Any key usages (for example, non-repudiation) that are requested in the CSR are added to the basic set of key
	// usages used for CA certs signed by this intermediate authority.
	//
	// 3) Extensions that are requested in the CSR are copied into the issued private certificate.
	UseCsrValues *bool `json:"use_csr_values,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The intermediate certificate authority to be signed. The name must match one of the pre-configured intermediate
	// certificate authorities.
	IntermediateCertificateAuthority *string `json:"intermediate_certificate_authority" validate:"required"`
}

SignIntermediateAction : A request to sign an intermediate certificate authority. This model "extends" ConfigAction

type SignIntermediateActionResult added in v1.0.39

type SignIntermediateActionResult struct {
	// The fully qualified domain name or host domain name for the certificate.
	CommonName *string `json:"common_name,omitempty"`

	// The Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	//
	// The alternative names can be host names or email addresses.
	AltNames *string `json:"alt_names,omitempty"`

	// The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	IPSans *string `json:"ip_sans,omitempty"`

	// The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.
	URISans *string `json:"uri_sans,omitempty"`

	// The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.
	//
	// The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated
	// certificate template. The format is the same as OpenSSL: `<oid>:<type>:<value>` where the current valid type is
	// `UTF8`.
	OtherSans []string `json:"other_sans,omitempty"`

	// The time-to-live (TTL) to assign to a private certificate.
	//
	// The value can be supplied as a string representation of a duration in hours, such as `12h`. The value can't exceed
	// the `max_ttl` that is defined in the associated certificate template.
	TTL interface{} `json:"ttl,omitempty"`

	// The format of the returned data.
	Format *string `json:"format,omitempty"`

	// The maximum path length to encode in the generated certificate. `-1` means no limit.
	//
	// If the signing certificate has a maximum path length set, the path length is set to one less than that of the
	// signing certificate. A limit of `0` means a literal path length of zero.
	MaxPathLength *int64 `json:"max_path_length,omitempty"`

	// Controls whether the common name is excluded from Subject Alternative Names (SANs).
	//
	// If set to `true`, the common name is is not included in DNS or Email SANs if they apply. This field can be useful if
	// the common name is not a hostname or an email address, but is instead a human-readable identifier.
	ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`

	// The allowed DNS domains or subdomains for the certificates to be signed and issued by this CA certificate.
	PermittedDNSDomains []string `json:"permitted_dns_domains,omitempty"`

	// Determines whether to use values from a certificate signing request (CSR) to complete a `sign_csr` action. If set to
	// `true`, then:
	//
	// 1) Subject information, including names and alternate names, are preserved from the CSR rather than using the values
	// provided in the other parameters to this operation.
	//
	// 2) Any key usages (for example, non-repudiation) that are requested in the CSR are added to the basic set of key
	// usages used for CA certs signed by this intermediate authority.
	//
	// 3) Extensions that are requested in the CSR are copied into the issued private certificate.
	UseCsrValues *bool `json:"use_csr_values,omitempty"`

	// The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
	Ou []string `json:"ou,omitempty"`

	// The Organization (O) values to define in the subject field of the resulting certificate.
	Organization []string `json:"organization,omitempty"`

	// The Country (C) values to define in the subject field of the resulting certificate.
	Country []string `json:"country,omitempty"`

	// The Locality (L) values to define in the subject field of the resulting certificate.
	Locality []string `json:"locality,omitempty"`

	// The Province (ST) values to define in the subject field of the resulting certificate.
	Province []string `json:"province,omitempty"`

	// The Street Address values in the subject field of the resulting certificate.
	StreetAddress []string `json:"street_address,omitempty"`

	// The Postal Code values in the subject field of the resulting certificate.
	PostalCode []string `json:"postal_code,omitempty"`

	// The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.
	SerialNumber *string `json:"serial_number,omitempty"`

	// Properties that are returned with a successful `sign` action.
	Data *SignIntermediateActionResultData `json:"data,omitempty"`

	// The signed intermediate certificate authority.
	IntermediateCertificateAuthority *string `json:"intermediate_certificate_authority" validate:"required"`
}

SignIntermediateActionResult : Properties that are returned with a successful `sign_intermediate` action. This model "extends" ConfigElementActionResultConfig

type SignIntermediateActionResultData added in v1.0.39

type SignIntermediateActionResultData struct {
	// The PEM-encoded certificate.
	Certificate *string `json:"certificate,omitempty"`

	// The unique serial number that was assigned to the certificate by the issuing certificate authority.
	SerialNumber *string `json:"serial_number,omitempty"`

	// The PEM-encoded certificate of the certificate authority that signed and issued this certificate.
	IssuingCa *string `json:"issuing_ca,omitempty"`

	// The chain of certificate authorities that are associated with the certificate.
	CaChain []string `json:"ca_chain,omitempty"`

	// The time until the certificate expires.
	Expiration *int64 `json:"expiration,omitempty"`
}

SignIntermediateActionResultData : Properties that are returned with a successful `sign` action.

type UnlockSecretOptions added in v1.0.45

type UnlockSecretOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// A comma-separated list of locks to delete.
	Locks []string `json:"locks,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UnlockSecretOptions : The UnlockSecret options.

func (*UnlockSecretOptions) SetHeaders added in v1.0.45

func (options *UnlockSecretOptions) SetHeaders(param map[string]string) *UnlockSecretOptions

SetHeaders : Allow user to set Headers

func (*UnlockSecretOptions) SetID added in v1.0.45

func (_options *UnlockSecretOptions) SetID(id string) *UnlockSecretOptions

SetID : Allow user to set ID

func (*UnlockSecretOptions) SetLocks added in v1.0.45

func (_options *UnlockSecretOptions) SetLocks(locks []string) *UnlockSecretOptions

SetLocks : Allow user to set Locks

func (*UnlockSecretOptions) SetSecretType added in v1.0.45

func (_options *UnlockSecretOptions) SetSecretType(secretType string) *UnlockSecretOptions

SetSecretType : Allow user to set SecretType

type UnlockSecretVersionOptions added in v1.0.45

type UnlockSecretVersionOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

	// A comma-separated list of locks to delete.
	Locks []string `json:"locks,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UnlockSecretVersionOptions : The UnlockSecretVersion options.

func (*UnlockSecretVersionOptions) SetHeaders added in v1.0.45

func (options *UnlockSecretVersionOptions) SetHeaders(param map[string]string) *UnlockSecretVersionOptions

SetHeaders : Allow user to set Headers

func (*UnlockSecretVersionOptions) SetID added in v1.0.45

SetID : Allow user to set ID

func (*UnlockSecretVersionOptions) SetLocks added in v1.0.45

func (_options *UnlockSecretVersionOptions) SetLocks(locks []string) *UnlockSecretVersionOptions

SetLocks : Allow user to set Locks

func (*UnlockSecretVersionOptions) SetSecretType added in v1.0.45

func (_options *UnlockSecretVersionOptions) SetSecretType(secretType string) *UnlockSecretVersionOptions

SetSecretType : Allow user to set SecretType

func (*UnlockSecretVersionOptions) SetVersionID added in v1.0.45

func (_options *UnlockSecretVersionOptions) SetVersionID(versionID string) *UnlockSecretVersionOptions

SetVersionID : Allow user to set VersionID

type UpdateConfigElementOptions added in v1.0.25

type UpdateConfigElementOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

	// The name of your configuration.
	ConfigName *string `json:"config_name" validate:"required,ne="`

	// The type of configuration. Value options differ depending on the `config_element` property that you want to define.
	Type *string `json:"type" validate:"required"`

	// Properties that describe a configuration, which depends on type.
	Config map[string]interface{} `json:"config" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateConfigElementOptions : The UpdateConfigElement options.

func (*UpdateConfigElementOptions) SetConfig added in v1.0.25

func (_options *UpdateConfigElementOptions) SetConfig(config map[string]interface{}) *UpdateConfigElementOptions

SetConfig : Allow user to set Config

func (*UpdateConfigElementOptions) SetConfigElement added in v1.0.25

func (_options *UpdateConfigElementOptions) SetConfigElement(configElement string) *UpdateConfigElementOptions

SetConfigElement : Allow user to set ConfigElement

func (*UpdateConfigElementOptions) SetConfigName added in v1.0.25

func (_options *UpdateConfigElementOptions) SetConfigName(configName string) *UpdateConfigElementOptions

SetConfigName : Allow user to set ConfigName

func (*UpdateConfigElementOptions) SetHeaders added in v1.0.25

func (options *UpdateConfigElementOptions) SetHeaders(param map[string]string) *UpdateConfigElementOptions

SetHeaders : Allow user to set Headers

func (*UpdateConfigElementOptions) SetSecretType added in v1.0.25

func (_options *UpdateConfigElementOptions) SetSecretType(secretType string) *UpdateConfigElementOptions

SetSecretType : Allow user to set SecretType

func (*UpdateConfigElementOptions) SetType added in v1.0.25

func (_options *UpdateConfigElementOptions) SetType(typeVar string) *UpdateConfigElementOptions

SetType : Allow user to set Type

type UpdateSecretGroupMetadataOptions

type UpdateSecretGroupMetadataOptions struct {
	// The v4 UUID that uniquely identifies the secret group.
	ID *string `json:"id" validate:"required,ne="`

	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretGroupMetadataUpdatable `json:"resources" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateSecretGroupMetadataOptions : The UpdateSecretGroupMetadata options.

func (*UpdateSecretGroupMetadataOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateSecretGroupMetadataOptions) SetID

SetID : Allow user to set ID

func (*UpdateSecretGroupMetadataOptions) SetMetadata

SetMetadata : Allow user to set Metadata

func (*UpdateSecretGroupMetadataOptions) SetResources

SetResources : Allow user to set Resources

type UpdateSecretMetadataOptions

type UpdateSecretMetadataOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []SecretMetadataIntf `json:"resources" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateSecretMetadataOptions : The UpdateSecretMetadata options.

func (*UpdateSecretMetadataOptions) SetHeaders

func (options *UpdateSecretMetadataOptions) SetHeaders(param map[string]string) *UpdateSecretMetadataOptions

SetHeaders : Allow user to set Headers

func (*UpdateSecretMetadataOptions) SetID

SetID : Allow user to set ID

func (*UpdateSecretMetadataOptions) SetMetadata

SetMetadata : Allow user to set Metadata

func (*UpdateSecretMetadataOptions) SetResources

func (_options *UpdateSecretMetadataOptions) SetResources(resources []SecretMetadataIntf) *UpdateSecretMetadataOptions

SetResources : Allow user to set Resources

func (*UpdateSecretMetadataOptions) SetSecretType

func (_options *UpdateSecretMetadataOptions) SetSecretType(secretType string) *UpdateSecretMetadataOptions

SetSecretType : Allow user to set SecretType

type UpdateSecretOptions

type UpdateSecretOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The action to perform on the specified secret.
	Action *string `json:"action" validate:"required"`

	// The properties to update for the secret.
	SecretAction SecretActionIntf `json:"SecretAction,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateSecretOptions : The UpdateSecret options.

func (*UpdateSecretOptions) SetAction

func (_options *UpdateSecretOptions) SetAction(action string) *UpdateSecretOptions

SetAction : Allow user to set Action

func (*UpdateSecretOptions) SetHeaders

func (options *UpdateSecretOptions) SetHeaders(param map[string]string) *UpdateSecretOptions

SetHeaders : Allow user to set Headers

func (*UpdateSecretOptions) SetID

func (_options *UpdateSecretOptions) SetID(id string) *UpdateSecretOptions

SetID : Allow user to set ID

func (*UpdateSecretOptions) SetSecretAction added in v1.0.22

func (_options *UpdateSecretOptions) SetSecretAction(secretAction SecretActionIntf) *UpdateSecretOptions

SetSecretAction : Allow user to set SecretAction

func (*UpdateSecretOptions) SetSecretType

func (_options *UpdateSecretOptions) SetSecretType(secretType string) *UpdateSecretOptions

SetSecretType : Allow user to set SecretType

type UpdateSecretVersionMetadata added in v1.0.46

type UpdateSecretVersionMetadata struct {
	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}

UpdateSecretVersionMetadata : Properties that update the metadata of a secret version.

type UpdateSecretVersionMetadataOptions added in v1.0.46

type UpdateSecretVersionMetadataOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata" validate:"required"`

	// A collection of resources.
	Resources []UpdateSecretVersionMetadata `json:"resources" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateSecretVersionMetadataOptions : The UpdateSecretVersionMetadata options.

func (*UpdateSecretVersionMetadataOptions) SetHeaders added in v1.0.46

SetHeaders : Allow user to set Headers

func (*UpdateSecretVersionMetadataOptions) SetID added in v1.0.46

SetID : Allow user to set ID

func (*UpdateSecretVersionMetadataOptions) SetMetadata added in v1.0.46

SetMetadata : Allow user to set Metadata

func (*UpdateSecretVersionMetadataOptions) SetResources added in v1.0.46

SetResources : Allow user to set Resources

func (*UpdateSecretVersionMetadataOptions) SetSecretType added in v1.0.46

SetSecretType : Allow user to set SecretType

func (*UpdateSecretVersionMetadataOptions) SetVersionID added in v1.0.46

SetVersionID : Allow user to set VersionID

type UpdateSecretVersionOptions added in v1.0.39

type UpdateSecretVersionOptions struct {
	// The secret type.
	SecretType *string `json:"secret_type" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

	// The action to perform on the specified secret version.
	Action *string `json:"action" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateSecretVersionOptions : The UpdateSecretVersion options.

func (*UpdateSecretVersionOptions) SetAction added in v1.0.39

func (_options *UpdateSecretVersionOptions) SetAction(action string) *UpdateSecretVersionOptions

SetAction : Allow user to set Action

func (*UpdateSecretVersionOptions) SetHeaders added in v1.0.39

func (options *UpdateSecretVersionOptions) SetHeaders(param map[string]string) *UpdateSecretVersionOptions

SetHeaders : Allow user to set Headers

func (*UpdateSecretVersionOptions) SetID added in v1.0.39

SetID : Allow user to set ID

func (*UpdateSecretVersionOptions) SetSecretType added in v1.0.39

func (_options *UpdateSecretVersionOptions) SetSecretType(secretType string) *UpdateSecretVersionOptions

SetSecretType : Allow user to set SecretType

func (*UpdateSecretVersionOptions) SetVersionID added in v1.0.39

func (_options *UpdateSecretVersionOptions) SetVersionID(versionID string) *UpdateSecretVersionOptions

SetVersionID : Allow user to set VersionID

type UsernamePasswordSecretMetadata added in v1.0.22

type UsernamePasswordSecretMetadata struct {
	// The unique ID of the secret.
	ID *string `json:"id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be in the range 2 - 30 characters, including spaces. Special characters
	// that are not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies the resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when any part of the secret metadata is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The date the secret material expires. The date format follows RFC 3339.
	//
	// You can set an expiration date on supported secret types at their creation. If you create a secret without
	// specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
	// following secret types:
	//
	// - `arbitrary`
	// - `username_password`.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
}

UsernamePasswordSecretMetadata : Metadata properties that describe a username_password secret. This model "extends" SecretMetadata

type UsernamePasswordSecretResource added in v1.0.22

type UsernamePasswordSecretResource struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// A human-readable alias to assign to your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.
	Name *string `json:"name" validate:"required"`

	// 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.
	Description *string `json:"description,omitempty"`

	// The v4 UUID that uniquely identifies the secret group to assign to this secret.
	//
	// If you omit this parameter, your secret is assigned to the `default` secret group.
	SecretGroupID *string `json:"secret_group_id,omitempty"`

	// Labels that you can use to filter for secrets in your instance.
	//
	// Up to 30 labels can be created. Labels can be 2 - 30 characters, including spaces. Special characters that are not
	// permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|).
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a label for your secret.
	Labels []string `json:"labels,omitempty"`

	// The secret state 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.
	State *int64 `json:"state,omitempty"`

	// A text representation of the secret state.
	StateDescription *string `json:"state_description,omitempty"`

	// The secret type.
	SecretType *string `json:"secret_type,omitempty"`

	// The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.
	CRN *string `json:"crn,omitempty"`

	// The date the secret was created. The date format follows RFC 3339.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret.
	CreatedBy *string `json:"created_by,omitempty"`

	// Updates when the actual secret is modified. The date format follows RFC 3339.
	LastUpdateDate *strfmt.DateTime `json:"last_update_date,omitempty"`

	// The number of versions that are associated with a secret.
	VersionsTotal *int64 `json:"versions_total,omitempty"`

	// An array that contains metadata for each secret version. For more information on the metadata properties, see [Get
	// secret version metadata](#get-secret-version-metadata).
	Versions []map[string]interface{} `json:"versions,omitempty"`

	// The number of locks that are associated with a secret.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret metadata that a user can customize.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// The username to assign to this secret.
	Username *string `json:"username,omitempty"`

	// The password to assign to this secret.
	Password *string `json:"password,omitempty"`

	// The data that is associated with the secret version. The data object contains the following fields:
	//
	// - `username`: The username that is associated with the secret version.
	// - `password`: The password that is associated with the secret version.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`

	// The date the secret material expires. The date format follows RFC 3339.
	//
	// You can set an expiration date on supported secret types at their creation. If you create a secret without
	// specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
	// following secret types:
	//
	// - `arbitrary`
	// - `username_password`.
	ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`

	// 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 can be auto-rotated and have an existing rotation policy.
	NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
}

UsernamePasswordSecretResource : Properties that describe a secret. This model "extends" SecretResource

type UsernamePasswordSecretVersion added in v1.0.28

type UsernamePasswordSecretVersion struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`

	// The data that is associated with the secret version. The data object contains the following fields:
	//
	// - `username`: The username that is associated with the secret version.
	// - `password`: The password that is associated with the secret version.
	SecretData map[string]interface{} `json:"secret_data,omitempty"`
}

UsernamePasswordSecretVersion : UsernamePasswordSecretVersion struct This model "extends" SecretVersion

type UsernamePasswordSecretVersionInfo added in v1.0.28

type UsernamePasswordSecretVersionInfo struct {
	// The ID of the secret version.
	ID *string `json:"id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`
}

UsernamePasswordSecretVersionInfo : UsernamePasswordSecretVersionInfo struct This model "extends" SecretVersionInfo

type UsernamePasswordSecretVersionMetadata added in v1.0.22

type UsernamePasswordSecretVersionMetadata struct {
	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id,omitempty"`

	// The ID of the secret version.
	VersionID *string `json:"version_id,omitempty"`

	// The date that the version of the secret was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the entity that created the secret version.
	CreatedBy *string `json:"created_by,omitempty"`

	// Indicates whether the payload for the secret version is stored and available.
	PayloadAvailable *bool `json:"payload_available,omitempty"`

	// Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service
	// API.
	Downloaded *bool `json:"downloaded,omitempty"`

	// The number of locks that are associated with a secret version.
	LocksTotal *int64 `json:"locks_total,omitempty"`

	// The secret version metadata that a user can customize.
	VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`

	// Indicates whether the version of the secret was created by automatic rotation.
	AutoRotated *bool `json:"auto_rotated,omitempty"`
}

UsernamePasswordSecretVersionMetadata : Properties that describe a secret version. This model "extends" SecretVersionMetadata

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL