Documentation
¶
Overview ¶
Package secretsmanagerv2 : Operations and models for the SecretsManagerV2 service
Index ¶
- Constants
- func ConstructServiceURL(providedUrlVariables map[string]string) (string, error)
- func GetServiceURLForRegion(region string) (string, error)
- func UnmarshalArbitrarySecret(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalArbitrarySecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalArbitrarySecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalArbitrarySecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalArbitrarySecretVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalArbitrarySecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalArbitrarySecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCertificateIssuanceInfo(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCertificateValidity(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalChallengeResource(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCommonRotationPolicy(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConfigurationAction(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConfigurationActionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConfigurationMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConfigurationMetadataPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConfigurationPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConfigurationPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsConfigurationMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsConfigurationPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsConfigurationPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsSecret(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsSecretRestoreFromVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIAMCredentialsSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalImportedCertificate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalImportedCertificateMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalImportedCertificateMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalImportedCertificatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalImportedCertificateVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalImportedCertificateVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalImportedCertificateVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalKVSecret(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalKVSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalKVSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalKVSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalKVSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalKVSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalKVSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNotificationsRegistration(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPaginatedCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPaginatedCollectionLast(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPaginatedCollectionNext(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPaginatedCollectionPrevious(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPasswordGenerationPolicy(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPasswordGenerationPolicyPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPasswordGenerationPolicyRO(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateActionRevoke(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateActionRevokePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateCAData(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionRevoke(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionRevokePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionRotateCRL(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionRotateCRLPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionSetSigned(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionSetSignedPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionSignCSR(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionSignCSRPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionSignIntermediate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationActionSignIntermediatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationCACertificate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationIntermediateCA(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationIntermediateCACSR(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationIntermediateCAMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationIntermediateCAPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationIntermediateCAPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationRootCA(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationRootCAMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationRootCAPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationRootCAPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationTemplate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationTemplateMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationTemplatePatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateConfigurationTemplatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateVersionActionRevoke(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateVersionActionRevokePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPrivateCertificateVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificate(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateActionValidateManualDNS(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateActionValidateManualDNSPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationCALetsEncrypt(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationCALetsEncryptMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationCALetsEncryptPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationCALetsEncryptPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructure(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructureMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructurePatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructurePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationDNSCloudInternetServices(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateRotationObject(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateRotationPolicy(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPublicCertificateVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalRotationPolicy(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecret(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretAction(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretActionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretGroup(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretGroupCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretGroupPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretLock(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretLockPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretLocks(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretLocksPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretMetadataPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretVersionActionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretVersionLocks(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretVersionLocksPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretVersionMetadataCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretVersionMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSecretsLocksPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsResourceKey(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecret(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretCredentials(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretSourceService(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretSourceServiceRO(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSourceServiceIam(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSourceServiceIamApikey(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSourceServiceIamRole(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSourceServiceIamServiceid(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSourceServiceInstance(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSourceServiceParameters(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalServiceCredentialsSourceServiceRole(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalUsernamePasswordSecret(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalUsernamePasswordSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalUsernamePasswordSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalUsernamePasswordSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalUsernamePasswordSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalUsernamePasswordSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalUsernamePasswordSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalVersionAction(m map[string]json.RawMessage, result interface{}) (err error)
- type ArbitrarySecret
- type ArbitrarySecretMetadata
- type ArbitrarySecretMetadataPatch
- type ArbitrarySecretPrototype
- type ArbitrarySecretVersion
- type ArbitrarySecretVersionMetadata
- type ArbitrarySecretVersionPrototype
- type CertificateIssuanceInfo
- type CertificateValidity
- type ChallengeResource
- type CommonRotationPolicy
- type Configuration
- type ConfigurationAction
- type ConfigurationActionIntf
- type ConfigurationActionPrototype
- type ConfigurationActionPrototypeIntf
- type ConfigurationIntf
- type ConfigurationMetadata
- type ConfigurationMetadataIntf
- type ConfigurationMetadataPaginatedCollection
- type ConfigurationPatch
- type ConfigurationPatchIntf
- type ConfigurationPrototype
- type ConfigurationPrototypeIntf
- type ConfigurationsPager
- func (pager *ConfigurationsPager) GetAll() (allItems []ConfigurationMetadataIntf, err error)
- func (pager *ConfigurationsPager) GetAllWithContext(ctx context.Context) (allItems []ConfigurationMetadataIntf, err error)
- func (pager *ConfigurationsPager) GetNext() (page []ConfigurationMetadataIntf, err error)
- func (pager *ConfigurationsPager) GetNextWithContext(ctx context.Context) (page []ConfigurationMetadataIntf, err error)
- func (pager *ConfigurationsPager) HasNext() bool
- type CreateConfigurationActionOptions
- func (_options *CreateConfigurationActionOptions) SetConfigActionPrototype(configActionPrototype ConfigurationActionPrototypeIntf) *CreateConfigurationActionOptions
- func (options *CreateConfigurationActionOptions) SetHeaders(param map[string]string) *CreateConfigurationActionOptions
- func (_options *CreateConfigurationActionOptions) SetName(name string) *CreateConfigurationActionOptions
- func (_options *CreateConfigurationActionOptions) SetXSmAcceptConfigurationType(xSmAcceptConfigurationType string) *CreateConfigurationActionOptions
- type CreateConfigurationOptions
- type CreateNotificationsRegistrationOptions
- func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsInstanceCrn(eventNotificationsInstanceCrn string) *CreateNotificationsRegistrationOptions
- func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsSourceDescription(eventNotificationsSourceDescription string) *CreateNotificationsRegistrationOptions
- func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsSourceName(eventNotificationsSourceName string) *CreateNotificationsRegistrationOptions
- func (options *CreateNotificationsRegistrationOptions) SetHeaders(param map[string]string) *CreateNotificationsRegistrationOptions
- type CreateSecretActionOptions
- func (options *CreateSecretActionOptions) SetHeaders(param map[string]string) *CreateSecretActionOptions
- func (_options *CreateSecretActionOptions) SetID(id string) *CreateSecretActionOptions
- func (_options *CreateSecretActionOptions) SetSecretActionPrototype(secretActionPrototype SecretActionPrototypeIntf) *CreateSecretActionOptions
- type CreateSecretGroupOptions
- type CreateSecretLocksBulkOptions
- func (options *CreateSecretLocksBulkOptions) SetHeaders(param map[string]string) *CreateSecretLocksBulkOptions
- func (_options *CreateSecretLocksBulkOptions) SetID(id string) *CreateSecretLocksBulkOptions
- func (_options *CreateSecretLocksBulkOptions) SetLocks(locks []SecretLockPrototype) *CreateSecretLocksBulkOptions
- func (_options *CreateSecretLocksBulkOptions) SetMode(mode string) *CreateSecretLocksBulkOptions
- type CreateSecretOptions
- type CreateSecretVersionActionOptions
- func (options *CreateSecretVersionActionOptions) SetHeaders(param map[string]string) *CreateSecretVersionActionOptions
- func (_options *CreateSecretVersionActionOptions) SetID(id string) *CreateSecretVersionActionOptions
- func (_options *CreateSecretVersionActionOptions) SetSecretID(secretID string) *CreateSecretVersionActionOptions
- func (_options *CreateSecretVersionActionOptions) SetSecretVersionActionPrototype(secretVersionActionPrototype SecretVersionActionPrototypeIntf) *CreateSecretVersionActionOptions
- type CreateSecretVersionLocksBulkOptions
- func (options *CreateSecretVersionLocksBulkOptions) SetHeaders(param map[string]string) *CreateSecretVersionLocksBulkOptions
- func (_options *CreateSecretVersionLocksBulkOptions) SetID(id string) *CreateSecretVersionLocksBulkOptions
- func (_options *CreateSecretVersionLocksBulkOptions) SetLocks(locks []SecretLockPrototype) *CreateSecretVersionLocksBulkOptions
- func (_options *CreateSecretVersionLocksBulkOptions) SetMode(mode string) *CreateSecretVersionLocksBulkOptions
- func (_options *CreateSecretVersionLocksBulkOptions) SetSecretID(secretID string) *CreateSecretVersionLocksBulkOptions
- type CreateSecretVersionOptions
- func (options *CreateSecretVersionOptions) SetHeaders(param map[string]string) *CreateSecretVersionOptions
- func (_options *CreateSecretVersionOptions) SetSecretID(secretID string) *CreateSecretVersionOptions
- func (_options *CreateSecretVersionOptions) SetSecretVersionPrototype(secretVersionPrototype SecretVersionPrototypeIntf) *CreateSecretVersionOptions
- type DeleteConfigurationOptions
- func (options *DeleteConfigurationOptions) SetHeaders(param map[string]string) *DeleteConfigurationOptions
- func (_options *DeleteConfigurationOptions) SetName(name string) *DeleteConfigurationOptions
- func (_options *DeleteConfigurationOptions) SetXSmAcceptConfigurationType(xSmAcceptConfigurationType string) *DeleteConfigurationOptions
- type DeleteNotificationsRegistrationOptions
- type DeleteSecretGroupOptions
- type DeleteSecretLocksBulkOptions
- func (options *DeleteSecretLocksBulkOptions) SetHeaders(param map[string]string) *DeleteSecretLocksBulkOptions
- func (_options *DeleteSecretLocksBulkOptions) SetID(id string) *DeleteSecretLocksBulkOptions
- func (_options *DeleteSecretLocksBulkOptions) SetName(name []string) *DeleteSecretLocksBulkOptions
- type DeleteSecretOptions
- type DeleteSecretVersionDataOptions
- func (options *DeleteSecretVersionDataOptions) SetHeaders(param map[string]string) *DeleteSecretVersionDataOptions
- func (_options *DeleteSecretVersionDataOptions) SetID(id string) *DeleteSecretVersionDataOptions
- func (_options *DeleteSecretVersionDataOptions) SetSecretID(secretID string) *DeleteSecretVersionDataOptions
- type DeleteSecretVersionLocksBulkOptions
- func (options *DeleteSecretVersionLocksBulkOptions) SetHeaders(param map[string]string) *DeleteSecretVersionLocksBulkOptions
- func (_options *DeleteSecretVersionLocksBulkOptions) SetID(id string) *DeleteSecretVersionLocksBulkOptions
- func (_options *DeleteSecretVersionLocksBulkOptions) SetName(name []string) *DeleteSecretVersionLocksBulkOptions
- func (_options *DeleteSecretVersionLocksBulkOptions) SetSecretID(secretID string) *DeleteSecretVersionLocksBulkOptions
- type GetConfigurationOptions
- func (options *GetConfigurationOptions) SetHeaders(param map[string]string) *GetConfigurationOptions
- func (_options *GetConfigurationOptions) SetName(name string) *GetConfigurationOptions
- func (_options *GetConfigurationOptions) SetXSmAcceptConfigurationType(xSmAcceptConfigurationType string) *GetConfigurationOptions
- type GetNotificationsRegistrationOptions
- type GetNotificationsRegistrationTestOptions
- type GetSecretByNameTypeOptions
- func (options *GetSecretByNameTypeOptions) SetHeaders(param map[string]string) *GetSecretByNameTypeOptions
- func (_options *GetSecretByNameTypeOptions) SetName(name string) *GetSecretByNameTypeOptions
- func (_options *GetSecretByNameTypeOptions) SetSecretGroupName(secretGroupName string) *GetSecretByNameTypeOptions
- func (_options *GetSecretByNameTypeOptions) SetSecretType(secretType string) *GetSecretByNameTypeOptions
- type GetSecretGroupOptions
- type GetSecretMetadataOptions
- type GetSecretOptions
- type GetSecretVersionMetadataOptions
- func (options *GetSecretVersionMetadataOptions) SetHeaders(param map[string]string) *GetSecretVersionMetadataOptions
- func (_options *GetSecretVersionMetadataOptions) SetID(id string) *GetSecretVersionMetadataOptions
- func (_options *GetSecretVersionMetadataOptions) SetSecretID(secretID string) *GetSecretVersionMetadataOptions
- type GetSecretVersionOptions
- type IAMCredentialsConfiguration
- type IAMCredentialsConfigurationMetadata
- type IAMCredentialsConfigurationPatch
- type IAMCredentialsConfigurationPrototype
- type IAMCredentialsSecret
- type IAMCredentialsSecretMetadata
- type IAMCredentialsSecretMetadataPatch
- type IAMCredentialsSecretPrototype
- type IAMCredentialsSecretRestoreFromVersionPrototype
- type IAMCredentialsSecretVersion
- type IAMCredentialsSecretVersionMetadata
- type IAMCredentialsSecretVersionPrototype
- type ImportedCertificate
- type ImportedCertificateMetadata
- type ImportedCertificateMetadataPatch
- type ImportedCertificatePrototype
- type ImportedCertificateVersion
- type ImportedCertificateVersionMetadata
- type ImportedCertificateVersionPrototype
- type KVSecret
- type KVSecretMetadata
- type KVSecretMetadataPatch
- type KVSecretPrototype
- type KVSecretVersion
- type KVSecretVersionMetadata
- type KVSecretVersionPrototype
- type ListConfigurationsOptions
- func (options *ListConfigurationsOptions) SetHeaders(param map[string]string) *ListConfigurationsOptions
- func (_options *ListConfigurationsOptions) SetLimit(limit int64) *ListConfigurationsOptions
- func (_options *ListConfigurationsOptions) SetOffset(offset int64) *ListConfigurationsOptions
- func (_options *ListConfigurationsOptions) SetSearch(search string) *ListConfigurationsOptions
- func (_options *ListConfigurationsOptions) SetSort(sort string) *ListConfigurationsOptions
- type ListSecretGroupsOptions
- type ListSecretLocksOptions
- func (options *ListSecretLocksOptions) SetHeaders(param map[string]string) *ListSecretLocksOptions
- func (_options *ListSecretLocksOptions) SetID(id string) *ListSecretLocksOptions
- func (_options *ListSecretLocksOptions) SetLimit(limit int64) *ListSecretLocksOptions
- func (_options *ListSecretLocksOptions) SetOffset(offset int64) *ListSecretLocksOptions
- func (_options *ListSecretLocksOptions) SetSearch(search string) *ListSecretLocksOptions
- func (_options *ListSecretLocksOptions) SetSort(sort string) *ListSecretLocksOptions
- type ListSecretVersionLocksOptions
- func (options *ListSecretVersionLocksOptions) SetHeaders(param map[string]string) *ListSecretVersionLocksOptions
- func (_options *ListSecretVersionLocksOptions) SetID(id string) *ListSecretVersionLocksOptions
- func (_options *ListSecretVersionLocksOptions) SetLimit(limit int64) *ListSecretVersionLocksOptions
- func (_options *ListSecretVersionLocksOptions) SetOffset(offset int64) *ListSecretVersionLocksOptions
- func (_options *ListSecretVersionLocksOptions) SetSearch(search string) *ListSecretVersionLocksOptions
- func (_options *ListSecretVersionLocksOptions) SetSecretID(secretID string) *ListSecretVersionLocksOptions
- func (_options *ListSecretVersionLocksOptions) SetSort(sort string) *ListSecretVersionLocksOptions
- type ListSecretVersionsOptions
- type ListSecretsLocksOptions
- func (_options *ListSecretsLocksOptions) SetGroups(groups []string) *ListSecretsLocksOptions
- func (options *ListSecretsLocksOptions) SetHeaders(param map[string]string) *ListSecretsLocksOptions
- func (_options *ListSecretsLocksOptions) SetLimit(limit int64) *ListSecretsLocksOptions
- func (_options *ListSecretsLocksOptions) SetOffset(offset int64) *ListSecretsLocksOptions
- func (_options *ListSecretsLocksOptions) SetSearch(search string) *ListSecretsLocksOptions
- type ListSecretsOptions
- func (_options *ListSecretsOptions) SetGroups(groups []string) *ListSecretsOptions
- func (options *ListSecretsOptions) SetHeaders(param map[string]string) *ListSecretsOptions
- func (_options *ListSecretsOptions) SetLimit(limit int64) *ListSecretsOptions
- func (_options *ListSecretsOptions) SetMatchAllLabels(matchAllLabels []string) *ListSecretsOptions
- func (_options *ListSecretsOptions) SetOffset(offset int64) *ListSecretsOptions
- func (_options *ListSecretsOptions) SetSearch(search string) *ListSecretsOptions
- func (_options *ListSecretsOptions) SetSecretTypes(secretTypes []string) *ListSecretsOptions
- func (_options *ListSecretsOptions) SetSort(sort string) *ListSecretsOptions
- type NotificationsRegistration
- type PaginatedCollectionFirst
- type PaginatedCollectionLast
- type PaginatedCollectionNext
- type PaginatedCollectionPrevious
- type PasswordGenerationPolicy
- type PasswordGenerationPolicyPatch
- type PasswordGenerationPolicyRO
- type PrivateCertificate
- type PrivateCertificateActionRevoke
- type PrivateCertificateActionRevokePrototype
- type PrivateCertificateCAData
- type PrivateCertificateCADataIntf
- type PrivateCertificateConfigurationActionRevoke
- type PrivateCertificateConfigurationActionRevokePrototype
- type PrivateCertificateConfigurationActionRotateCRL
- type PrivateCertificateConfigurationActionRotateCRLPrototype
- type PrivateCertificateConfigurationActionSetSigned
- type PrivateCertificateConfigurationActionSetSignedPrototype
- type PrivateCertificateConfigurationActionSignCSR
- type PrivateCertificateConfigurationActionSignCSRPrototype
- type PrivateCertificateConfigurationActionSignIntermediate
- type PrivateCertificateConfigurationActionSignIntermediatePrototype
- type PrivateCertificateConfigurationCACertificate
- type PrivateCertificateConfigurationIntermediateCA
- type PrivateCertificateConfigurationIntermediateCACSR
- type PrivateCertificateConfigurationIntermediateCAMetadata
- type PrivateCertificateConfigurationIntermediateCAPatch
- type PrivateCertificateConfigurationIntermediateCAPrototype
- type PrivateCertificateConfigurationRootCA
- type PrivateCertificateConfigurationRootCAMetadata
- type PrivateCertificateConfigurationRootCAPatch
- type PrivateCertificateConfigurationRootCAPrototype
- type PrivateCertificateConfigurationTemplate
- type PrivateCertificateConfigurationTemplateMetadata
- type PrivateCertificateConfigurationTemplatePatch
- type PrivateCertificateConfigurationTemplatePrototype
- type PrivateCertificateMetadata
- type PrivateCertificateMetadataPatch
- type PrivateCertificatePrototype
- type PrivateCertificateVersion
- type PrivateCertificateVersionActionRevoke
- type PrivateCertificateVersionActionRevokePrototype
- type PrivateCertificateVersionMetadata
- type PrivateCertificateVersionPrototype
- type PublicCertificate
- type PublicCertificateActionValidateManualDNS
- type PublicCertificateActionValidateManualDNSPrototype
- type PublicCertificateConfigurationCALetsEncrypt
- type PublicCertificateConfigurationCALetsEncryptMetadata
- type PublicCertificateConfigurationCALetsEncryptPatch
- type PublicCertificateConfigurationCALetsEncryptPrototype
- type PublicCertificateConfigurationDNSClassicInfrastructure
- type PublicCertificateConfigurationDNSClassicInfrastructureMetadata
- type PublicCertificateConfigurationDNSClassicInfrastructurePatch
- type PublicCertificateConfigurationDNSClassicInfrastructurePrototype
- type PublicCertificateConfigurationDNSCloudInternetServices
- type PublicCertificateConfigurationDNSCloudInternetServicesMetadata
- type PublicCertificateConfigurationDNSCloudInternetServicesPatch
- type PublicCertificateConfigurationDNSCloudInternetServicesPrototype
- type PublicCertificateMetadata
- type PublicCertificateMetadataPatch
- type PublicCertificatePrototype
- type PublicCertificateRotationObject
- type PublicCertificateRotationPolicy
- type PublicCertificateVersion
- type PublicCertificateVersionMetadata
- type PublicCertificateVersionPrototype
- type RotationPolicy
- type RotationPolicyIntf
- type Secret
- type SecretAction
- type SecretActionIntf
- type SecretActionPrototype
- type SecretActionPrototypeIntf
- type SecretGroup
- type SecretGroupCollection
- type SecretGroupPatch
- type SecretIntf
- type SecretLock
- type SecretLockPrototype
- type SecretLocks
- type SecretLocksPager
- func (pager *SecretLocksPager) GetAll() (allItems []SecretLock, err error)
- func (pager *SecretLocksPager) GetAllWithContext(ctx context.Context) (allItems []SecretLock, err error)
- func (pager *SecretLocksPager) GetNext() (page []SecretLock, err error)
- func (pager *SecretLocksPager) GetNextWithContext(ctx context.Context) (page []SecretLock, err error)
- func (pager *SecretLocksPager) HasNext() bool
- type SecretLocksPaginatedCollection
- type SecretMetadata
- type SecretMetadataIntf
- type SecretMetadataPaginatedCollection
- type SecretMetadataPatch
- type SecretMetadataPatchIntf
- type SecretPrototype
- type SecretPrototypeIntf
- type SecretVersion
- type SecretVersionActionPrototype
- type SecretVersionActionPrototypeIntf
- type SecretVersionIntf
- type SecretVersionLocks
- type SecretVersionLocksPager
- func (pager *SecretVersionLocksPager) GetAll() (allItems []SecretLock, err error)
- func (pager *SecretVersionLocksPager) GetAllWithContext(ctx context.Context) (allItems []SecretLock, err error)
- func (pager *SecretVersionLocksPager) GetNext() (page []SecretLock, err error)
- func (pager *SecretVersionLocksPager) GetNextWithContext(ctx context.Context) (page []SecretLock, err error)
- func (pager *SecretVersionLocksPager) HasNext() bool
- type SecretVersionLocksPaginatedCollection
- type SecretVersionMetadata
- type SecretVersionMetadataCollection
- type SecretVersionMetadataIntf
- type SecretVersionMetadataPatch
- type SecretVersionPrototype
- type SecretVersionPrototypeIntf
- type SecretsLocksPager
- func (pager *SecretsLocksPager) GetAll() (allItems []SecretLocks, err error)
- func (pager *SecretsLocksPager) GetAllWithContext(ctx context.Context) (allItems []SecretLocks, err error)
- func (pager *SecretsLocksPager) GetNext() (page []SecretLocks, err error)
- func (pager *SecretsLocksPager) GetNextWithContext(ctx context.Context) (page []SecretLocks, err error)
- func (pager *SecretsLocksPager) HasNext() bool
- type SecretsLocksPaginatedCollection
- type SecretsManagerV2
- func (secretsManager *SecretsManagerV2) Clone() *SecretsManagerV2
- func (secretsManager *SecretsManagerV2) CreateConfiguration(createConfigurationOptions *CreateConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateConfigurationAction(createConfigurationActionOptions *CreateConfigurationActionOptions) (result ConfigurationActionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateConfigurationActionWithContext(ctx context.Context, ...) (result ConfigurationActionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateConfigurationWithContext(ctx context.Context, createConfigurationOptions *CreateConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateNotificationsRegistration(createNotificationsRegistrationOptions *CreateNotificationsRegistrationOptions) (result *NotificationsRegistration, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateNotificationsRegistrationWithContext(ctx context.Context, ...) (result *NotificationsRegistration, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecret(createSecretOptions *CreateSecretOptions) (result SecretIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretAction(createSecretActionOptions *CreateSecretActionOptions) (result SecretActionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretActionWithContext(ctx context.Context, createSecretActionOptions *CreateSecretActionOptions) (result SecretActionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretGroup(createSecretGroupOptions *CreateSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretGroupWithContext(ctx context.Context, createSecretGroupOptions *CreateSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretLocksBulk(createSecretLocksBulkOptions *CreateSecretLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretLocksBulkWithContext(ctx context.Context, ...) (result *SecretLocks, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretVersion(createSecretVersionOptions *CreateSecretVersionOptions) (result SecretVersionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretVersionAction(createSecretVersionActionOptions *CreateSecretVersionActionOptions) (result VersionActionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretVersionActionWithContext(ctx context.Context, ...) (result VersionActionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretVersionLocksBulk(createSecretVersionLocksBulkOptions *CreateSecretVersionLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretVersionLocksBulkWithContext(ctx context.Context, ...) (result *SecretLocks, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretVersionWithContext(ctx context.Context, createSecretVersionOptions *CreateSecretVersionOptions) (result SecretVersionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) CreateSecretWithContext(ctx context.Context, createSecretOptions *CreateSecretOptions) (result SecretIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteConfiguration(deleteConfigurationOptions *DeleteConfigurationOptions) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteConfigurationWithContext(ctx context.Context, deleteConfigurationOptions *DeleteConfigurationOptions) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteNotificationsRegistration(deleteNotificationsRegistrationOptions *DeleteNotificationsRegistrationOptions) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteNotificationsRegistrationWithContext(ctx context.Context, ...) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecret(deleteSecretOptions *DeleteSecretOptions) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretGroup(deleteSecretGroupOptions *DeleteSecretGroupOptions) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretGroupWithContext(ctx context.Context, deleteSecretGroupOptions *DeleteSecretGroupOptions) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretLocksBulk(deleteSecretLocksBulkOptions *DeleteSecretLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretLocksBulkWithContext(ctx context.Context, ...) (result *SecretLocks, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretVersionData(deleteSecretVersionDataOptions *DeleteSecretVersionDataOptions) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretVersionDataWithContext(ctx context.Context, ...) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretVersionLocksBulk(deleteSecretVersionLocksBulkOptions *DeleteSecretVersionLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretVersionLocksBulkWithContext(ctx context.Context, ...) (result *SecretLocks, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DeleteSecretWithContext(ctx context.Context, deleteSecretOptions *DeleteSecretOptions) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) DisableRetries()
- func (secretsManager *SecretsManagerV2) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
- func (secretsManager *SecretsManagerV2) GetConfiguration(getConfigurationOptions *GetConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetConfigurationWithContext(ctx context.Context, getConfigurationOptions *GetConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetEnableGzipCompression() bool
- func (secretsManager *SecretsManagerV2) GetNotificationsRegistration(getNotificationsRegistrationOptions *GetNotificationsRegistrationOptions) (result *NotificationsRegistration, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetNotificationsRegistrationTest(...) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetNotificationsRegistrationTestWithContext(ctx context.Context, ...) (response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetNotificationsRegistrationWithContext(ctx context.Context, ...) (result *NotificationsRegistration, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecret(getSecretOptions *GetSecretOptions) (result SecretIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretByNameType(getSecretByNameTypeOptions *GetSecretByNameTypeOptions) (result SecretIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretByNameTypeWithContext(ctx context.Context, getSecretByNameTypeOptions *GetSecretByNameTypeOptions) (result SecretIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretGroup(getSecretGroupOptions *GetSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretGroupWithContext(ctx context.Context, getSecretGroupOptions *GetSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretMetadata(getSecretMetadataOptions *GetSecretMetadataOptions) (result SecretMetadataIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretMetadataWithContext(ctx context.Context, getSecretMetadataOptions *GetSecretMetadataOptions) (result SecretMetadataIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretVersion(getSecretVersionOptions *GetSecretVersionOptions) (result SecretVersionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretVersionMetadata(getSecretVersionMetadataOptions *GetSecretVersionMetadataOptions) (result SecretVersionMetadataIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretVersionMetadataWithContext(ctx context.Context, ...) (result SecretVersionMetadataIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretVersionWithContext(ctx context.Context, getSecretVersionOptions *GetSecretVersionOptions) (result SecretVersionIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetSecretWithContext(ctx context.Context, getSecretOptions *GetSecretOptions) (result SecretIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) GetServiceURL() string
- func (secretsManager *SecretsManagerV2) ListConfigurations(listConfigurationsOptions *ListConfigurationsOptions) (result *ConfigurationMetadataPaginatedCollection, ...)
- func (secretsManager *SecretsManagerV2) ListConfigurationsWithContext(ctx context.Context, listConfigurationsOptions *ListConfigurationsOptions) (result *ConfigurationMetadataPaginatedCollection, ...)
- func (secretsManager *SecretsManagerV2) ListSecretGroups(listSecretGroupsOptions *ListSecretGroupsOptions) (result *SecretGroupCollection, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) ListSecretGroupsWithContext(ctx context.Context, listSecretGroupsOptions *ListSecretGroupsOptions) (result *SecretGroupCollection, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) ListSecretLocks(listSecretLocksOptions *ListSecretLocksOptions) (result *SecretLocksPaginatedCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecretLocksWithContext(ctx context.Context, listSecretLocksOptions *ListSecretLocksOptions) (result *SecretLocksPaginatedCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecretVersionLocks(listSecretVersionLocksOptions *ListSecretVersionLocksOptions) (result *SecretVersionLocksPaginatedCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecretVersionLocksWithContext(ctx context.Context, ...) (result *SecretVersionLocksPaginatedCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecretVersions(listSecretVersionsOptions *ListSecretVersionsOptions) (result *SecretVersionMetadataCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecretVersionsWithContext(ctx context.Context, listSecretVersionsOptions *ListSecretVersionsOptions) (result *SecretVersionMetadataCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecrets(listSecretsOptions *ListSecretsOptions) (result *SecretMetadataPaginatedCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecretsLocks(listSecretsLocksOptions *ListSecretsLocksOptions) (result *SecretsLocksPaginatedCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecretsLocksWithContext(ctx context.Context, listSecretsLocksOptions *ListSecretsLocksOptions) (result *SecretsLocksPaginatedCollection, response *core.DetailedResponse, ...)
- func (secretsManager *SecretsManagerV2) ListSecretsWithContext(ctx context.Context, listSecretsOptions *ListSecretsOptions) (result *SecretMetadataPaginatedCollection, response *core.DetailedResponse, ...)
- func (*SecretsManagerV2) NewArbitrarySecretPrototype(name string, secretType string, payload string) (_model *ArbitrarySecretPrototype, err error)
- func (*SecretsManagerV2) NewArbitrarySecretVersionPrototype(payload string) (_model *ArbitrarySecretVersionPrototype, err error)
- func (*SecretsManagerV2) NewCommonRotationPolicy(autoRotate bool) (_model *CommonRotationPolicy, err error)
- func (secretsManager *SecretsManagerV2) NewConfigurationsPager(options *ListConfigurationsOptions) (pager *ConfigurationsPager, err error)
- func (*SecretsManagerV2) NewCreateConfigurationActionOptions(name string, configActionPrototype ConfigurationActionPrototypeIntf) *CreateConfigurationActionOptions
- func (*SecretsManagerV2) NewCreateConfigurationOptions(configurationPrototype ConfigurationPrototypeIntf) *CreateConfigurationOptions
- func (*SecretsManagerV2) NewCreateNotificationsRegistrationOptions(eventNotificationsInstanceCrn string, eventNotificationsSourceName string) *CreateNotificationsRegistrationOptions
- func (*SecretsManagerV2) NewCreateSecretActionOptions(id string, secretActionPrototype SecretActionPrototypeIntf) *CreateSecretActionOptions
- func (*SecretsManagerV2) NewCreateSecretGroupOptions(name string) *CreateSecretGroupOptions
- func (*SecretsManagerV2) NewCreateSecretLocksBulkOptions(id string, locks []SecretLockPrototype) *CreateSecretLocksBulkOptions
- func (*SecretsManagerV2) NewCreateSecretOptions(secretPrototype SecretPrototypeIntf) *CreateSecretOptions
- func (*SecretsManagerV2) NewCreateSecretVersionActionOptions(secretID string, id string, ...) *CreateSecretVersionActionOptions
- func (*SecretsManagerV2) NewCreateSecretVersionLocksBulkOptions(secretID string, id string, locks []SecretLockPrototype) *CreateSecretVersionLocksBulkOptions
- func (*SecretsManagerV2) NewCreateSecretVersionOptions(secretID string, secretVersionPrototype SecretVersionPrototypeIntf) *CreateSecretVersionOptions
- func (*SecretsManagerV2) NewDeleteConfigurationOptions(name string) *DeleteConfigurationOptions
- func (*SecretsManagerV2) NewDeleteNotificationsRegistrationOptions() *DeleteNotificationsRegistrationOptions
- func (*SecretsManagerV2) NewDeleteSecretGroupOptions(id string) *DeleteSecretGroupOptions
- func (*SecretsManagerV2) NewDeleteSecretLocksBulkOptions(id string) *DeleteSecretLocksBulkOptions
- func (*SecretsManagerV2) NewDeleteSecretOptions(id string) *DeleteSecretOptions
- func (*SecretsManagerV2) NewDeleteSecretVersionDataOptions(secretID string, id string) *DeleteSecretVersionDataOptions
- func (*SecretsManagerV2) NewDeleteSecretVersionLocksBulkOptions(secretID string, id string) *DeleteSecretVersionLocksBulkOptions
- func (*SecretsManagerV2) NewGetConfigurationOptions(name string) *GetConfigurationOptions
- func (*SecretsManagerV2) NewGetNotificationsRegistrationOptions() *GetNotificationsRegistrationOptions
- func (*SecretsManagerV2) NewGetNotificationsRegistrationTestOptions() *GetNotificationsRegistrationTestOptions
- func (*SecretsManagerV2) NewGetSecretByNameTypeOptions(secretType string, name string, secretGroupName string) *GetSecretByNameTypeOptions
- func (*SecretsManagerV2) NewGetSecretGroupOptions(id string) *GetSecretGroupOptions
- func (*SecretsManagerV2) NewGetSecretMetadataOptions(id string) *GetSecretMetadataOptions
- func (*SecretsManagerV2) NewGetSecretOptions(id string) *GetSecretOptions
- func (*SecretsManagerV2) NewGetSecretVersionMetadataOptions(secretID string, id string) *GetSecretVersionMetadataOptions
- func (*SecretsManagerV2) NewGetSecretVersionOptions(secretID string, id string) *GetSecretVersionOptions
- func (*SecretsManagerV2) NewIAMCredentialsConfigurationPatch(apiKey string) (_model *IAMCredentialsConfigurationPatch, err error)
- func (*SecretsManagerV2) NewIAMCredentialsConfigurationPrototype(name string, configType string, apiKey string) (_model *IAMCredentialsConfigurationPrototype, err error)
- func (*SecretsManagerV2) NewIAMCredentialsSecretPrototype(secretType string, name string, ttl string, reuseApiKey bool) (_model *IAMCredentialsSecretPrototype, err error)
- func (*SecretsManagerV2) NewIAMCredentialsSecretRestoreFromVersionPrototype(restoreFromVersion string) (_model *IAMCredentialsSecretRestoreFromVersionPrototype, err error)
- func (*SecretsManagerV2) NewImportedCertificatePrototype(secretType string, name string, certificate string) (_model *ImportedCertificatePrototype, err error)
- func (*SecretsManagerV2) NewImportedCertificateVersionPrototype(certificate string) (_model *ImportedCertificateVersionPrototype, err error)
- func (*SecretsManagerV2) NewKVSecretPrototype(secretType string, name string, data map[string]interface{}) (_model *KVSecretPrototype, err error)
- func (*SecretsManagerV2) NewKVSecretVersionPrototype(data map[string]interface{}) (_model *KVSecretVersionPrototype, err error)
- func (*SecretsManagerV2) NewListConfigurationsOptions() *ListConfigurationsOptions
- func (*SecretsManagerV2) NewListSecretGroupsOptions() *ListSecretGroupsOptions
- func (*SecretsManagerV2) NewListSecretLocksOptions(id string) *ListSecretLocksOptions
- func (*SecretsManagerV2) NewListSecretVersionLocksOptions(secretID string, id string) *ListSecretVersionLocksOptions
- func (*SecretsManagerV2) NewListSecretVersionsOptions(secretID string) *ListSecretVersionsOptions
- func (*SecretsManagerV2) NewListSecretsLocksOptions() *ListSecretsLocksOptions
- func (*SecretsManagerV2) NewListSecretsOptions() *ListSecretsOptions
- func (*SecretsManagerV2) NewPrivateCertificateActionRevokePrototype(actionType string) (_model *PrivateCertificateActionRevokePrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionRevokePrototype(actionType string) (_model *PrivateCertificateConfigurationActionRevokePrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionRotateCRLPrototype(actionType string) (_model *PrivateCertificateConfigurationActionRotateCRLPrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSetSignedPrototype(actionType string, certificate string) (_model *PrivateCertificateConfigurationActionSetSignedPrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSignCSRPrototype(actionType string, csr string) (_model *PrivateCertificateConfigurationActionSignCSRPrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSignIntermediatePrototype(actionType string, intermediateCertificateAuthority string) (_model *PrivateCertificateConfigurationActionSignIntermediatePrototype, ...)
- func (*SecretsManagerV2) NewPrivateCertificateConfigurationIntermediateCAPrototype(configType string, name string, maxTTL string, signingMethod string, ...) (_model *PrivateCertificateConfigurationIntermediateCAPrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificateConfigurationRootCAPrototype(configType string, name string, maxTTL string, commonName string) (_model *PrivateCertificateConfigurationRootCAPrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificateConfigurationTemplatePrototype(configType string, name string, certificateAuthority string) (_model *PrivateCertificateConfigurationTemplatePrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificatePrototype(secretType string, name string, certificateTemplate string, commonName string) (_model *PrivateCertificatePrototype, err error)
- func (*SecretsManagerV2) NewPrivateCertificateVersionActionRevokePrototype(actionType string) (_model *PrivateCertificateVersionActionRevokePrototype, err error)
- func (*SecretsManagerV2) NewPublicCertificateActionValidateManualDNSPrototype(actionType string) (_model *PublicCertificateActionValidateManualDNSPrototype, err error)
- func (*SecretsManagerV2) NewPublicCertificateConfigurationCALetsEncryptPatch(letsEncryptEnvironment string) (_model *PublicCertificateConfigurationCALetsEncryptPatch, err error)
- func (*SecretsManagerV2) NewPublicCertificateConfigurationCALetsEncryptPrototype(configType string, name string, letsEncryptEnvironment string, ...) (_model *PublicCertificateConfigurationCALetsEncryptPrototype, err error)
- func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSClassicInfrastructurePrototype(configType string, name string, classicInfrastructureUsername string, ...) (_model *PublicCertificateConfigurationDNSClassicInfrastructurePrototype, ...)
- func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSCloudInternetServicesPatch(cloudInternetServicesApikey string) (_model *PublicCertificateConfigurationDNSCloudInternetServicesPatch, err error)
- func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSCloudInternetServicesPrototype(configType string, name string, cloudInternetServicesCrn string) (_model *PublicCertificateConfigurationDNSCloudInternetServicesPrototype, ...)
- func (*SecretsManagerV2) NewPublicCertificatePrototype(secretType string, name string, commonName string, ca string, dns string) (_model *PublicCertificatePrototype, err error)
- func (*SecretsManagerV2) NewPublicCertificateRotationPolicy(autoRotate bool, rotateKeys bool) (_model *PublicCertificateRotationPolicy, err error)
- func (*SecretsManagerV2) NewPublicCertificateVersionPrototype(rotation *PublicCertificateRotationObject) (_model *PublicCertificateVersionPrototype, err error)
- func (*SecretsManagerV2) NewSecretLockPrototype(name string) (_model *SecretLockPrototype, err error)
- func (secretsManager *SecretsManagerV2) NewSecretLocksPager(options *ListSecretLocksOptions) (pager *SecretLocksPager, err error)
- func (secretsManager *SecretsManagerV2) NewSecretVersionLocksPager(options *ListSecretVersionLocksOptions) (pager *SecretVersionLocksPager, err error)
- func (secretsManager *SecretsManagerV2) NewSecretsLocksPager(options *ListSecretsLocksOptions) (pager *SecretsLocksPager, err error)
- func (secretsManager *SecretsManagerV2) NewSecretsPager(options *ListSecretsOptions) (pager *SecretsPager, err error)
- func (*SecretsManagerV2) NewServiceCredentialsSecretPrototype(name string, secretType string, ...) (_model *ServiceCredentialsSecretPrototype, err error)
- func (*SecretsManagerV2) NewServiceCredentialsSecretSourceService(instance *ServiceCredentialsSourceServiceInstance) (_model *ServiceCredentialsSecretSourceService, err error)
- func (*SecretsManagerV2) NewServiceCredentialsSourceServiceRole(crn string) (_model *ServiceCredentialsSourceServiceRole, err error)
- func (*SecretsManagerV2) NewUpdateConfigurationOptions(name string, configurationPatch map[string]interface{}) *UpdateConfigurationOptions
- func (*SecretsManagerV2) NewUpdateSecretGroupOptions(id string, secretGroupPatch map[string]interface{}) *UpdateSecretGroupOptions
- func (*SecretsManagerV2) NewUpdateSecretMetadataOptions(id string, secretMetadataPatch map[string]interface{}) *UpdateSecretMetadataOptions
- func (*SecretsManagerV2) NewUpdateSecretVersionMetadataOptions(secretID string, id string, secretVersionMetadataPatch map[string]interface{}) *UpdateSecretVersionMetadataOptions
- func (*SecretsManagerV2) NewUsernamePasswordSecretPrototype(secretType string, name string, username string) (_model *UsernamePasswordSecretPrototype, err error)
- func (secretsManager *SecretsManagerV2) SetDefaultHeaders(headers http.Header)
- func (secretsManager *SecretsManagerV2) SetEnableGzipCompression(enableGzip bool)
- func (secretsManager *SecretsManagerV2) SetServiceURL(url string) error
- func (secretsManager *SecretsManagerV2) UpdateConfiguration(updateConfigurationOptions *UpdateConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) UpdateConfigurationWithContext(ctx context.Context, updateConfigurationOptions *UpdateConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) UpdateSecretGroup(updateSecretGroupOptions *UpdateSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) UpdateSecretGroupWithContext(ctx context.Context, updateSecretGroupOptions *UpdateSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) UpdateSecretMetadata(updateSecretMetadataOptions *UpdateSecretMetadataOptions) (result SecretMetadataIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) UpdateSecretMetadataWithContext(ctx context.Context, updateSecretMetadataOptions *UpdateSecretMetadataOptions) (result SecretMetadataIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) UpdateSecretVersionMetadata(updateSecretVersionMetadataOptions *UpdateSecretVersionMetadataOptions) (result SecretVersionMetadataIntf, response *core.DetailedResponse, err error)
- func (secretsManager *SecretsManagerV2) UpdateSecretVersionMetadataWithContext(ctx context.Context, ...) (result SecretVersionMetadataIntf, response *core.DetailedResponse, err error)
- type SecretsManagerV2Options
- type SecretsPager
- func (pager *SecretsPager) GetAll() (allItems []SecretMetadataIntf, err error)
- func (pager *SecretsPager) GetAllWithContext(ctx context.Context) (allItems []SecretMetadataIntf, err error)
- func (pager *SecretsPager) GetNext() (page []SecretMetadataIntf, err error)
- func (pager *SecretsPager) GetNextWithContext(ctx context.Context) (page []SecretMetadataIntf, err error)
- func (pager *SecretsPager) HasNext() bool
- type ServiceCredentialsResourceKey
- type ServiceCredentialsSecret
- type ServiceCredentialsSecretCredentials
- func (o *ServiceCredentialsSecretCredentials) GetProperties() map[string]interface{}
- func (o *ServiceCredentialsSecretCredentials) GetProperty(key string) interface{}
- func (o *ServiceCredentialsSecretCredentials) MarshalJSON() (buffer []byte, err error)
- func (o *ServiceCredentialsSecretCredentials) SetProperties(m map[string]interface{})
- func (o *ServiceCredentialsSecretCredentials) SetProperty(key string, value interface{})
- type ServiceCredentialsSecretMetadata
- type ServiceCredentialsSecretMetadataPatch
- type ServiceCredentialsSecretPrototype
- type ServiceCredentialsSecretSourceService
- type ServiceCredentialsSecretSourceServiceRO
- type ServiceCredentialsSecretVersion
- type ServiceCredentialsSecretVersionMetadata
- type ServiceCredentialsSecretVersionPrototype
- type ServiceCredentialsSourceServiceIam
- type ServiceCredentialsSourceServiceIamApikey
- type ServiceCredentialsSourceServiceIamRole
- type ServiceCredentialsSourceServiceIamServiceid
- type ServiceCredentialsSourceServiceInstance
- type ServiceCredentialsSourceServiceParameters
- func (o *ServiceCredentialsSourceServiceParameters) GetProperties() map[string]interface{}
- func (o *ServiceCredentialsSourceServiceParameters) GetProperty(key string) interface{}
- func (o *ServiceCredentialsSourceServiceParameters) MarshalJSON() (buffer []byte, err error)
- func (o *ServiceCredentialsSourceServiceParameters) SetProperties(m map[string]interface{})
- func (o *ServiceCredentialsSourceServiceParameters) SetProperty(key string, value interface{})
- type ServiceCredentialsSourceServiceRole
- type UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetConfigurationPatch(configurationPatch map[string]interface{}) *UpdateConfigurationOptions
- func (options *UpdateConfigurationOptions) SetHeaders(param map[string]string) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetName(name string) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetXSmAcceptConfigurationType(xSmAcceptConfigurationType string) *UpdateConfigurationOptions
- type UpdateSecretGroupOptions
- func (options *UpdateSecretGroupOptions) SetHeaders(param map[string]string) *UpdateSecretGroupOptions
- func (_options *UpdateSecretGroupOptions) SetID(id string) *UpdateSecretGroupOptions
- func (_options *UpdateSecretGroupOptions) SetSecretGroupPatch(secretGroupPatch map[string]interface{}) *UpdateSecretGroupOptions
- type UpdateSecretMetadataOptions
- func (options *UpdateSecretMetadataOptions) SetHeaders(param map[string]string) *UpdateSecretMetadataOptions
- func (_options *UpdateSecretMetadataOptions) SetID(id string) *UpdateSecretMetadataOptions
- func (_options *UpdateSecretMetadataOptions) SetSecretMetadataPatch(secretMetadataPatch map[string]interface{}) *UpdateSecretMetadataOptions
- type UpdateSecretVersionMetadataOptions
- func (options *UpdateSecretVersionMetadataOptions) SetHeaders(param map[string]string) *UpdateSecretVersionMetadataOptions
- func (_options *UpdateSecretVersionMetadataOptions) SetID(id string) *UpdateSecretVersionMetadataOptions
- func (_options *UpdateSecretVersionMetadataOptions) SetSecretID(secretID string) *UpdateSecretVersionMetadataOptions
- func (_options *UpdateSecretVersionMetadataOptions) SetSecretVersionMetadataPatch(secretVersionMetadataPatch map[string]interface{}) *UpdateSecretVersionMetadataOptions
- type UsernamePasswordSecret
- type UsernamePasswordSecretMetadata
- type UsernamePasswordSecretMetadataPatch
- type UsernamePasswordSecretPrototype
- type UsernamePasswordSecretVersion
- type UsernamePasswordSecretVersionMetadata
- type UsernamePasswordSecretVersionPrototype
- type VersionAction
- type VersionActionIntf
Constants ¶
View Source
const ( CertificateIssuanceInfo_StateDescription_Active = "active" CertificateIssuanceInfo_StateDescription_Deactivated = "deactivated" CertificateIssuanceInfo_StateDescription_Destroyed = "destroyed" CertificateIssuanceInfo_StateDescription_PreActivation = "pre_activation" CertificateIssuanceInfo_StateDescription_Suspended = "suspended" )
Constants associated with the CertificateIssuanceInfo.StateDescription property. A text representation of the secret state.
View Source
const ( Configuration_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" Configuration_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" Configuration_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" Configuration_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" Configuration_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" Configuration_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" Configuration_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the Configuration.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( Configuration_SecretType_Arbitrary = "arbitrary" Configuration_SecretType_IamCredentials = "iam_credentials" Configuration_SecretType_ImportedCert = "imported_cert" Configuration_SecretType_Kv = "kv" Configuration_SecretType_PrivateCert = "private_cert" Configuration_SecretType_PublicCert = "public_cert" Configuration_SecretType_ServiceCredentials = "service_credentials" Configuration_SecretType_UsernamePassword = "username_password" )
Constants associated with the Configuration.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( Configuration_LetsEncryptEnvironment_Production = "production" Configuration_LetsEncryptEnvironment_Staging = "staging" )
Constants associated with the Configuration.LetsEncryptEnvironment property. The configuration of the Let's Encrypt CA environment.
View Source
const ( Configuration_KeyType_Ec = "ec" Configuration_KeyType_Rsa = "rsa" )
Constants associated with the Configuration.KeyType property. The type of private key to generate.
View Source
const ( Configuration_Status_CertificateTemplateRequired = "certificate_template_required" Configuration_Status_Configured = "configured" Configuration_Status_Expired = "expired" Configuration_Status_Revoked = "revoked" Configuration_Status_SignedCertificateRequired = "signed_certificate_required" Configuration_Status_SigningRequired = "signing_required" )
Constants associated with the Configuration.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 ( Configuration_Format_Pem = "pem" Configuration_Format_PemBundle = "pem_bundle" )
Constants associated with the Configuration.Format property. The format of the returned data.
View Source
const ( Configuration_PrivateKeyFormat_Der = "der" Configuration_PrivateKeyFormat_Pkcs8 = "pkcs8" )
Constants associated with the Configuration.PrivateKeyFormat property. The format of the generated private key.
View Source
const ( Configuration_SigningMethod_External = "external" Configuration_SigningMethod_Internal = "internal" )
Constants associated with the Configuration.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 ( ConfigurationAction_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" ConfigurationAction_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" ConfigurationAction_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" ConfigurationAction_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" ConfigurationAction_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the ConfigurationAction.ActionType property. The type of configuration action.
View Source
const ( ConfigurationAction_Format_Pem = "pem" ConfigurationAction_Format_PemBundle = "pem_bundle" )
Constants associated with the ConfigurationAction.Format property. The format of the returned data.
View Source
const ( ConfigurationActionPrototype_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" ConfigurationActionPrototype_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" ConfigurationActionPrototype_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" ConfigurationActionPrototype_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" ConfigurationActionPrototype_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the ConfigurationActionPrototype.ActionType property. The type of configuration action.
View Source
const ( ConfigurationActionPrototype_Format_Pem = "pem" ConfigurationActionPrototype_Format_PemBundle = "pem_bundle" )
Constants associated with the ConfigurationActionPrototype.Format property. The format of the returned data.
View Source
const ( ConfigurationMetadata_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" ConfigurationMetadata_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" ConfigurationMetadata_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" ConfigurationMetadata_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" ConfigurationMetadata_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" ConfigurationMetadata_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" ConfigurationMetadata_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the ConfigurationMetadata.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( ConfigurationMetadata_SecretType_Arbitrary = "arbitrary" ConfigurationMetadata_SecretType_IamCredentials = "iam_credentials" ConfigurationMetadata_SecretType_ImportedCert = "imported_cert" ConfigurationMetadata_SecretType_Kv = "kv" ConfigurationMetadata_SecretType_PrivateCert = "private_cert" ConfigurationMetadata_SecretType_PublicCert = "public_cert" ConfigurationMetadata_SecretType_ServiceCredentials = "service_credentials" ConfigurationMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the ConfigurationMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ConfigurationMetadata_LetsEncryptEnvironment_Production = "production" ConfigurationMetadata_LetsEncryptEnvironment_Staging = "staging" )
Constants associated with the ConfigurationMetadata.LetsEncryptEnvironment property. The configuration of the Let's Encrypt CA environment.
View Source
const ( ConfigurationMetadata_KeyType_Ec = "ec" ConfigurationMetadata_KeyType_Rsa = "rsa" )
Constants associated with the ConfigurationMetadata.KeyType property. The type of private key to generate.
View Source
const ( ConfigurationMetadata_Status_CertificateTemplateRequired = "certificate_template_required" ConfigurationMetadata_Status_Configured = "configured" ConfigurationMetadata_Status_Expired = "expired" ConfigurationMetadata_Status_Revoked = "revoked" ConfigurationMetadata_Status_SignedCertificateRequired = "signed_certificate_required" ConfigurationMetadata_Status_SigningRequired = "signing_required" )
Constants associated with the ConfigurationMetadata.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 ( ConfigurationMetadata_SigningMethod_External = "external" ConfigurationMetadata_SigningMethod_Internal = "internal" )
Constants associated with the ConfigurationMetadata.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 ( ConfigurationPatch_KeyType_Ec = "ec" ConfigurationPatch_KeyType_Rsa = "rsa" )
Constants associated with the ConfigurationPatch.KeyType property. The type of private key to generate.
View Source
const ( ConfigurationPatch_LetsEncryptEnvironment_Production = "production" ConfigurationPatch_LetsEncryptEnvironment_Staging = "staging" )
Constants associated with the ConfigurationPatch.LetsEncryptEnvironment property. The configuration of the Let's Encrypt CA environment.
View Source
const ( ConfigurationPrototype_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" ConfigurationPrototype_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" ConfigurationPrototype_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" ConfigurationPrototype_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" ConfigurationPrototype_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" ConfigurationPrototype_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" ConfigurationPrototype_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the ConfigurationPrototype.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( ConfigurationPrototype_Format_Pem = "pem" ConfigurationPrototype_Format_PemBundle = "pem_bundle" )
Constants associated with the ConfigurationPrototype.Format property. The format of the returned data.
View Source
const ( ConfigurationPrototype_PrivateKeyFormat_Der = "der" ConfigurationPrototype_PrivateKeyFormat_Pkcs8 = "pkcs8" )
Constants associated with the ConfigurationPrototype.PrivateKeyFormat property. The format of the generated private key.
View Source
const ( ConfigurationPrototype_KeyType_Ec = "ec" ConfigurationPrototype_KeyType_Rsa = "rsa" )
Constants associated with the ConfigurationPrototype.KeyType property. The type of private key to generate.
View Source
const ( ConfigurationPrototype_SigningMethod_External = "external" ConfigurationPrototype_SigningMethod_Internal = "internal" )
Constants associated with the ConfigurationPrototype.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 ( ConfigurationPrototype_LetsEncryptEnvironment_Production = "production" ConfigurationPrototype_LetsEncryptEnvironment_Staging = "staging" )
Constants associated with the ConfigurationPrototype.LetsEncryptEnvironment property. The configuration of the Let's Encrypt CA environment.
View Source
const ( CreateConfigurationActionOptions_XSmAcceptConfigurationType_IamCredentialsConfiguration = "iam_credentials_configuration" CreateConfigurationActionOptions_XSmAcceptConfigurationType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" CreateConfigurationActionOptions_XSmAcceptConfigurationType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" CreateConfigurationActionOptions_XSmAcceptConfigurationType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" CreateConfigurationActionOptions_XSmAcceptConfigurationType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" CreateConfigurationActionOptions_XSmAcceptConfigurationType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" CreateConfigurationActionOptions_XSmAcceptConfigurationType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the CreateConfigurationActionOptions.XSmAcceptConfigurationType property. The configuration type of this configuration - use this header to resolve 300 error responses.
View Source
const ( CreateSecretLocksBulkOptions_Mode_RemovePrevious = "remove_previous" CreateSecretLocksBulkOptions_Mode_RemovePreviousAndDelete = "remove_previous_and_delete" )
Constants associated with the CreateSecretLocksBulkOptions.Mode property. An optional lock mode. When you create a lock, you can set one of the following modes to clear any matching locks on a secret version. - `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the secret. - `remove_previous_and_delete`: Completes the same action as `remove_previous`, but also permanently deletes the data of the previous secret version if it doesn't have any locks.
View Source
const ( CreateSecretVersionLocksBulkOptions_Mode_RemovePrevious = "remove_previous" CreateSecretVersionLocksBulkOptions_Mode_RemovePreviousAndDelete = "remove_previous_and_delete" )
Constants associated with the CreateSecretVersionLocksBulkOptions.Mode property. An optional lock mode. When you create a lock, you can set one of the following modes to clear any matching locks on a secret version. - `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the secret. - `remove_previous_and_delete`: Completes the same action as `remove_previous`, but also permanently deletes the data of the previous secret version if it doesn't have any locks.
View Source
const ( DeleteConfigurationOptions_XSmAcceptConfigurationType_IamCredentialsConfiguration = "iam_credentials_configuration" DeleteConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" DeleteConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" DeleteConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" DeleteConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" DeleteConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" DeleteConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the DeleteConfigurationOptions.XSmAcceptConfigurationType property. The configuration type of this configuration - use this header to resolve 300 error responses.
View Source
const ( GetConfigurationOptions_XSmAcceptConfigurationType_IamCredentialsConfiguration = "iam_credentials_configuration" GetConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" GetConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" GetConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" GetConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" GetConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" GetConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the GetConfigurationOptions.XSmAcceptConfigurationType property. The configuration type of this configuration - use this header to resolve 300 error responses.
View Source
const ( GetSecretByNameTypeOptions_SecretType_Arbitrary = "arbitrary" GetSecretByNameTypeOptions_SecretType_IamCredentials = "iam_credentials" GetSecretByNameTypeOptions_SecretType_ImportedCert = "imported_cert" GetSecretByNameTypeOptions_SecretType_Kv = "kv" GetSecretByNameTypeOptions_SecretType_PrivateCert = "private_cert" GetSecretByNameTypeOptions_SecretType_PublicCert = "public_cert" GetSecretByNameTypeOptions_SecretType_ServiceCredentials = "service_credentials" GetSecretByNameTypeOptions_SecretType_UsernamePassword = "username_password" )
Constants associated with the GetSecretByNameTypeOptions.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ListSecretsOptions_SecretTypes_Arbitrary = "arbitrary" ListSecretsOptions_SecretTypes_IamCredentials = "iam_credentials" ListSecretsOptions_SecretTypes_ImportedCert = "imported_cert" ListSecretsOptions_SecretTypes_Kv = "kv" ListSecretsOptions_SecretTypes_PrivateCert = "private_cert" ListSecretsOptions_SecretTypes_PublicCert = "public_cert" ListSecretsOptions_SecretTypes_ServiceCredentials = "service_credentials" ListSecretsOptions_SecretTypes_UsernamePassword = "username_password" )
Constants associated with the ListSecretsOptions.SecretTypes property.
View Source
const ( PrivateCertificateCAData_PrivateKeyType_Ec = "ec" PrivateCertificateCAData_PrivateKeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateCAData.PrivateKeyType property. The type of private key to generate.
View Source
const ( RotationPolicy_Unit_Day = "day" RotationPolicy_Unit_Month = "month" )
Constants associated with the RotationPolicy.Unit property. The units for the secret rotation time interval.
View Source
const ( Secret_SecretType_Arbitrary = "arbitrary" Secret_SecretType_IamCredentials = "iam_credentials" Secret_SecretType_ImportedCert = "imported_cert" Secret_SecretType_Kv = "kv" Secret_SecretType_PrivateCert = "private_cert" Secret_SecretType_PublicCert = "public_cert" Secret_SecretType_ServiceCredentials = "service_credentials" Secret_SecretType_UsernamePassword = "username_password" )
Constants associated with the Secret.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( Secret_StateDescription_Active = "active" Secret_StateDescription_Deactivated = "deactivated" Secret_StateDescription_Destroyed = "destroyed" Secret_StateDescription_PreActivation = "pre_activation" Secret_StateDescription_Suspended = "suspended" )
Constants associated with the Secret.StateDescription property. A text representation of the secret state.
View Source
const ( SecretAction_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate" SecretAction_ActionType_PublicCertActionValidateDnsChallenge = "public_cert_action_validate_dns_challenge" )
Constants associated with the SecretAction.ActionType property. The type of secret action.
View Source
const ( SecretActionPrototype_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate" SecretActionPrototype_ActionType_PublicCertActionValidateDnsChallenge = "public_cert_action_validate_dns_challenge" )
Constants associated with the SecretActionPrototype.ActionType property. The type of secret action.
View Source
const ( SecretLock_SecretVersionAlias_Current = "current" SecretLock_SecretVersionAlias_Previous = "previous" )
Constants associated with the SecretLock.SecretVersionAlias 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 ( SecretLocks_SecretType_Arbitrary = "arbitrary" SecretLocks_SecretType_IamCredentials = "iam_credentials" SecretLocks_SecretType_ImportedCert = "imported_cert" SecretLocks_SecretType_Kv = "kv" SecretLocks_SecretType_PrivateCert = "private_cert" SecretLocks_SecretType_PublicCert = "public_cert" SecretLocks_SecretType_ServiceCredentials = "service_credentials" SecretLocks_SecretType_UsernamePassword = "username_password" )
Constants associated with the SecretLocks.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( SecretMetadata_SecretType_Arbitrary = "arbitrary" SecretMetadata_SecretType_IamCredentials = "iam_credentials" SecretMetadata_SecretType_ImportedCert = "imported_cert" SecretMetadata_SecretType_Kv = "kv" SecretMetadata_SecretType_PrivateCert = "private_cert" SecretMetadata_SecretType_PublicCert = "public_cert" SecretMetadata_SecretType_ServiceCredentials = "service_credentials" SecretMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the SecretMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( SecretMetadata_StateDescription_Active = "active" SecretMetadata_StateDescription_Deactivated = "deactivated" SecretMetadata_StateDescription_Destroyed = "destroyed" SecretMetadata_StateDescription_PreActivation = "pre_activation" SecretMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the SecretMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( SecretPrototype_SecretType_Arbitrary = "arbitrary" SecretPrototype_SecretType_IamCredentials = "iam_credentials" SecretPrototype_SecretType_ImportedCert = "imported_cert" SecretPrototype_SecretType_Kv = "kv" SecretPrototype_SecretType_PrivateCert = "private_cert" SecretPrototype_SecretType_PublicCert = "public_cert" SecretPrototype_SecretType_ServiceCredentials = "service_credentials" SecretPrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the SecretPrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( SecretPrototype_Format_Pem = "pem" SecretPrototype_Format_PemBundle = "pem_bundle" )
Constants associated with the SecretPrototype.Format property. The format of the returned data.
View Source
const ( SecretPrototype_PrivateKeyFormat_Der = "der" SecretPrototype_PrivateKeyFormat_Pkcs8 = "pkcs8" )
Constants associated with the SecretPrototype.PrivateKeyFormat property. The format of the generated private key.
View Source
const ( SecretVersion_SecretType_Arbitrary = "arbitrary" SecretVersion_SecretType_IamCredentials = "iam_credentials" SecretVersion_SecretType_ImportedCert = "imported_cert" SecretVersion_SecretType_Kv = "kv" SecretVersion_SecretType_PrivateCert = "private_cert" SecretVersion_SecretType_PublicCert = "public_cert" SecretVersion_SecretType_ServiceCredentials = "service_credentials" SecretVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the SecretVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( SecretVersion_Alias_Current = "current" SecretVersion_Alias_Previous = "previous" )
Constants associated with the SecretVersion.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 ( SecretVersionLocks_VersionAlias_Current = "current" SecretVersionLocks_VersionAlias_Previous = "previous" )
Constants associated with the SecretVersionLocks.VersionAlias 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 ( SecretVersionMetadata_SecretType_Arbitrary = "arbitrary" SecretVersionMetadata_SecretType_IamCredentials = "iam_credentials" SecretVersionMetadata_SecretType_ImportedCert = "imported_cert" SecretVersionMetadata_SecretType_Kv = "kv" SecretVersionMetadata_SecretType_PrivateCert = "private_cert" SecretVersionMetadata_SecretType_PublicCert = "public_cert" SecretVersionMetadata_SecretType_ServiceCredentials = "service_credentials" SecretVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the SecretVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( SecretVersionMetadata_Alias_Current = "current" SecretVersionMetadata_Alias_Previous = "previous" )
Constants associated with the SecretVersionMetadata.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 ( UpdateConfigurationOptions_XSmAcceptConfigurationType_IamCredentialsConfiguration = "iam_credentials_configuration" UpdateConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" UpdateConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" UpdateConfigurationOptions_XSmAcceptConfigurationType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" UpdateConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" UpdateConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" UpdateConfigurationOptions_XSmAcceptConfigurationType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the UpdateConfigurationOptions.XSmAcceptConfigurationType property. The configuration type of this configuration - use this header to resolve 300 error responses.
View Source
const ( ArbitrarySecret_SecretType_Arbitrary = "arbitrary" ArbitrarySecret_SecretType_IamCredentials = "iam_credentials" ArbitrarySecret_SecretType_ImportedCert = "imported_cert" ArbitrarySecret_SecretType_Kv = "kv" ArbitrarySecret_SecretType_PrivateCert = "private_cert" ArbitrarySecret_SecretType_PublicCert = "public_cert" ArbitrarySecret_SecretType_ServiceCredentials = "service_credentials" ArbitrarySecret_SecretType_UsernamePassword = "username_password" )
Constants associated with the ArbitrarySecret.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ArbitrarySecret_StateDescription_Active = "active" ArbitrarySecret_StateDescription_Deactivated = "deactivated" ArbitrarySecret_StateDescription_Destroyed = "destroyed" ArbitrarySecret_StateDescription_PreActivation = "pre_activation" ArbitrarySecret_StateDescription_Suspended = "suspended" )
Constants associated with the ArbitrarySecret.StateDescription property. A text representation of the secret state.
View Source
const ( ArbitrarySecretMetadata_SecretType_Arbitrary = "arbitrary" ArbitrarySecretMetadata_SecretType_IamCredentials = "iam_credentials" ArbitrarySecretMetadata_SecretType_ImportedCert = "imported_cert" ArbitrarySecretMetadata_SecretType_Kv = "kv" ArbitrarySecretMetadata_SecretType_PrivateCert = "private_cert" ArbitrarySecretMetadata_SecretType_PublicCert = "public_cert" ArbitrarySecretMetadata_SecretType_ServiceCredentials = "service_credentials" ArbitrarySecretMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the ArbitrarySecretMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ArbitrarySecretMetadata_StateDescription_Active = "active" ArbitrarySecretMetadata_StateDescription_Deactivated = "deactivated" ArbitrarySecretMetadata_StateDescription_Destroyed = "destroyed" ArbitrarySecretMetadata_StateDescription_PreActivation = "pre_activation" ArbitrarySecretMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the ArbitrarySecretMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( ArbitrarySecretPrototype_SecretType_Arbitrary = "arbitrary" ArbitrarySecretPrototype_SecretType_IamCredentials = "iam_credentials" ArbitrarySecretPrototype_SecretType_ImportedCert = "imported_cert" ArbitrarySecretPrototype_SecretType_Kv = "kv" ArbitrarySecretPrototype_SecretType_PrivateCert = "private_cert" ArbitrarySecretPrototype_SecretType_PublicCert = "public_cert" ArbitrarySecretPrototype_SecretType_ServiceCredentials = "service_credentials" ArbitrarySecretPrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the ArbitrarySecretPrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ArbitrarySecretVersion_SecretType_Arbitrary = "arbitrary" ArbitrarySecretVersion_SecretType_IamCredentials = "iam_credentials" ArbitrarySecretVersion_SecretType_ImportedCert = "imported_cert" ArbitrarySecretVersion_SecretType_Kv = "kv" ArbitrarySecretVersion_SecretType_PrivateCert = "private_cert" ArbitrarySecretVersion_SecretType_PublicCert = "public_cert" ArbitrarySecretVersion_SecretType_ServiceCredentials = "service_credentials" ArbitrarySecretVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the ArbitrarySecretVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ArbitrarySecretVersion_Alias_Current = "current" ArbitrarySecretVersion_Alias_Previous = "previous" )
Constants associated with the ArbitrarySecretVersion.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 ( ArbitrarySecretVersionMetadata_SecretType_Arbitrary = "arbitrary" ArbitrarySecretVersionMetadata_SecretType_IamCredentials = "iam_credentials" ArbitrarySecretVersionMetadata_SecretType_ImportedCert = "imported_cert" ArbitrarySecretVersionMetadata_SecretType_Kv = "kv" ArbitrarySecretVersionMetadata_SecretType_PrivateCert = "private_cert" ArbitrarySecretVersionMetadata_SecretType_PublicCert = "public_cert" ArbitrarySecretVersionMetadata_SecretType_ServiceCredentials = "service_credentials" ArbitrarySecretVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the ArbitrarySecretVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ArbitrarySecretVersionMetadata_Alias_Current = "current" ArbitrarySecretVersionMetadata_Alias_Previous = "previous" )
Constants associated with the ArbitrarySecretVersionMetadata.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 ( CommonRotationPolicy_Unit_Day = "day" CommonRotationPolicy_Unit_Month = "month" )
Constants associated with the CommonRotationPolicy.Unit property. The units for the secret rotation time interval.
View Source
const ( IAMCredentialsConfiguration_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" IAMCredentialsConfiguration_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" IAMCredentialsConfiguration_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" IAMCredentialsConfiguration_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" IAMCredentialsConfiguration_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" IAMCredentialsConfiguration_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" IAMCredentialsConfiguration_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the IAMCredentialsConfiguration.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( IAMCredentialsConfiguration_SecretType_Arbitrary = "arbitrary" IAMCredentialsConfiguration_SecretType_IamCredentials = "iam_credentials" IAMCredentialsConfiguration_SecretType_ImportedCert = "imported_cert" IAMCredentialsConfiguration_SecretType_Kv = "kv" IAMCredentialsConfiguration_SecretType_PrivateCert = "private_cert" IAMCredentialsConfiguration_SecretType_PublicCert = "public_cert" IAMCredentialsConfiguration_SecretType_ServiceCredentials = "service_credentials" IAMCredentialsConfiguration_SecretType_UsernamePassword = "username_password" )
Constants associated with the IAMCredentialsConfiguration.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( IAMCredentialsConfigurationMetadata_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" IAMCredentialsConfigurationMetadata_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" IAMCredentialsConfigurationMetadata_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" IAMCredentialsConfigurationMetadata_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" IAMCredentialsConfigurationMetadata_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" IAMCredentialsConfigurationMetadata_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" IAMCredentialsConfigurationMetadata_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the IAMCredentialsConfigurationMetadata.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( IAMCredentialsConfigurationMetadata_SecretType_Arbitrary = "arbitrary" IAMCredentialsConfigurationMetadata_SecretType_IamCredentials = "iam_credentials" IAMCredentialsConfigurationMetadata_SecretType_ImportedCert = "imported_cert" IAMCredentialsConfigurationMetadata_SecretType_Kv = "kv" IAMCredentialsConfigurationMetadata_SecretType_PrivateCert = "private_cert" IAMCredentialsConfigurationMetadata_SecretType_PublicCert = "public_cert" IAMCredentialsConfigurationMetadata_SecretType_ServiceCredentials = "service_credentials" IAMCredentialsConfigurationMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the IAMCredentialsConfigurationMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( IAMCredentialsConfigurationPrototype_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" IAMCredentialsConfigurationPrototype_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" IAMCredentialsConfigurationPrototype_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" IAMCredentialsConfigurationPrototype_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" IAMCredentialsConfigurationPrototype_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" IAMCredentialsConfigurationPrototype_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" IAMCredentialsConfigurationPrototype_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the IAMCredentialsConfigurationPrototype.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( IAMCredentialsSecret_SecretType_Arbitrary = "arbitrary" IAMCredentialsSecret_SecretType_IamCredentials = "iam_credentials" IAMCredentialsSecret_SecretType_ImportedCert = "imported_cert" IAMCredentialsSecret_SecretType_Kv = "kv" IAMCredentialsSecret_SecretType_PrivateCert = "private_cert" IAMCredentialsSecret_SecretType_PublicCert = "public_cert" IAMCredentialsSecret_SecretType_ServiceCredentials = "service_credentials" IAMCredentialsSecret_SecretType_UsernamePassword = "username_password" )
Constants associated with the IAMCredentialsSecret.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( IAMCredentialsSecret_StateDescription_Active = "active" IAMCredentialsSecret_StateDescription_Deactivated = "deactivated" IAMCredentialsSecret_StateDescription_Destroyed = "destroyed" IAMCredentialsSecret_StateDescription_PreActivation = "pre_activation" IAMCredentialsSecret_StateDescription_Suspended = "suspended" )
Constants associated with the IAMCredentialsSecret.StateDescription property. A text representation of the secret state.
View Source
const ( IAMCredentialsSecretMetadata_SecretType_Arbitrary = "arbitrary" IAMCredentialsSecretMetadata_SecretType_IamCredentials = "iam_credentials" IAMCredentialsSecretMetadata_SecretType_ImportedCert = "imported_cert" IAMCredentialsSecretMetadata_SecretType_Kv = "kv" IAMCredentialsSecretMetadata_SecretType_PrivateCert = "private_cert" IAMCredentialsSecretMetadata_SecretType_PublicCert = "public_cert" IAMCredentialsSecretMetadata_SecretType_ServiceCredentials = "service_credentials" IAMCredentialsSecretMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the IAMCredentialsSecretMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( IAMCredentialsSecretMetadata_StateDescription_Active = "active" IAMCredentialsSecretMetadata_StateDescription_Deactivated = "deactivated" IAMCredentialsSecretMetadata_StateDescription_Destroyed = "destroyed" IAMCredentialsSecretMetadata_StateDescription_PreActivation = "pre_activation" IAMCredentialsSecretMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the IAMCredentialsSecretMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( IAMCredentialsSecretPrototype_SecretType_Arbitrary = "arbitrary" IAMCredentialsSecretPrototype_SecretType_IamCredentials = "iam_credentials" IAMCredentialsSecretPrototype_SecretType_ImportedCert = "imported_cert" IAMCredentialsSecretPrototype_SecretType_Kv = "kv" IAMCredentialsSecretPrototype_SecretType_PrivateCert = "private_cert" IAMCredentialsSecretPrototype_SecretType_PublicCert = "public_cert" IAMCredentialsSecretPrototype_SecretType_ServiceCredentials = "service_credentials" IAMCredentialsSecretPrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the IAMCredentialsSecretPrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( IAMCredentialsSecretVersion_SecretType_Arbitrary = "arbitrary" IAMCredentialsSecretVersion_SecretType_IamCredentials = "iam_credentials" IAMCredentialsSecretVersion_SecretType_ImportedCert = "imported_cert" IAMCredentialsSecretVersion_SecretType_Kv = "kv" IAMCredentialsSecretVersion_SecretType_PrivateCert = "private_cert" IAMCredentialsSecretVersion_SecretType_PublicCert = "public_cert" IAMCredentialsSecretVersion_SecretType_ServiceCredentials = "service_credentials" IAMCredentialsSecretVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the IAMCredentialsSecretVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( IAMCredentialsSecretVersion_Alias_Current = "current" IAMCredentialsSecretVersion_Alias_Previous = "previous" )
Constants associated with the IAMCredentialsSecretVersion.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 ( IAMCredentialsSecretVersionMetadata_SecretType_Arbitrary = "arbitrary" IAMCredentialsSecretVersionMetadata_SecretType_IamCredentials = "iam_credentials" IAMCredentialsSecretVersionMetadata_SecretType_ImportedCert = "imported_cert" IAMCredentialsSecretVersionMetadata_SecretType_Kv = "kv" IAMCredentialsSecretVersionMetadata_SecretType_PrivateCert = "private_cert" IAMCredentialsSecretVersionMetadata_SecretType_PublicCert = "public_cert" IAMCredentialsSecretVersionMetadata_SecretType_ServiceCredentials = "service_credentials" IAMCredentialsSecretVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the IAMCredentialsSecretVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( IAMCredentialsSecretVersionMetadata_Alias_Current = "current" IAMCredentialsSecretVersionMetadata_Alias_Previous = "previous" )
Constants associated with the IAMCredentialsSecretVersionMetadata.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 ( ImportedCertificate_SecretType_Arbitrary = "arbitrary" ImportedCertificate_SecretType_IamCredentials = "iam_credentials" ImportedCertificate_SecretType_ImportedCert = "imported_cert" ImportedCertificate_SecretType_Kv = "kv" ImportedCertificate_SecretType_PrivateCert = "private_cert" ImportedCertificate_SecretType_PublicCert = "public_cert" ImportedCertificate_SecretType_ServiceCredentials = "service_credentials" ImportedCertificate_SecretType_UsernamePassword = "username_password" )
Constants associated with the ImportedCertificate.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ImportedCertificate_StateDescription_Active = "active" ImportedCertificate_StateDescription_Deactivated = "deactivated" ImportedCertificate_StateDescription_Destroyed = "destroyed" ImportedCertificate_StateDescription_PreActivation = "pre_activation" ImportedCertificate_StateDescription_Suspended = "suspended" )
Constants associated with the ImportedCertificate.StateDescription property. A text representation of the secret state.
View Source
const ( ImportedCertificateMetadata_SecretType_Arbitrary = "arbitrary" ImportedCertificateMetadata_SecretType_IamCredentials = "iam_credentials" ImportedCertificateMetadata_SecretType_ImportedCert = "imported_cert" ImportedCertificateMetadata_SecretType_Kv = "kv" ImportedCertificateMetadata_SecretType_PrivateCert = "private_cert" ImportedCertificateMetadata_SecretType_PublicCert = "public_cert" ImportedCertificateMetadata_SecretType_ServiceCredentials = "service_credentials" ImportedCertificateMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the ImportedCertificateMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ImportedCertificateMetadata_StateDescription_Active = "active" ImportedCertificateMetadata_StateDescription_Deactivated = "deactivated" ImportedCertificateMetadata_StateDescription_Destroyed = "destroyed" ImportedCertificateMetadata_StateDescription_PreActivation = "pre_activation" ImportedCertificateMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the ImportedCertificateMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( ImportedCertificatePrototype_SecretType_Arbitrary = "arbitrary" ImportedCertificatePrototype_SecretType_IamCredentials = "iam_credentials" ImportedCertificatePrototype_SecretType_ImportedCert = "imported_cert" ImportedCertificatePrototype_SecretType_Kv = "kv" ImportedCertificatePrototype_SecretType_PrivateCert = "private_cert" ImportedCertificatePrototype_SecretType_PublicCert = "public_cert" ImportedCertificatePrototype_SecretType_ServiceCredentials = "service_credentials" ImportedCertificatePrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the ImportedCertificatePrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ImportedCertificateVersion_SecretType_Arbitrary = "arbitrary" ImportedCertificateVersion_SecretType_IamCredentials = "iam_credentials" ImportedCertificateVersion_SecretType_ImportedCert = "imported_cert" ImportedCertificateVersion_SecretType_Kv = "kv" ImportedCertificateVersion_SecretType_PrivateCert = "private_cert" ImportedCertificateVersion_SecretType_PublicCert = "public_cert" ImportedCertificateVersion_SecretType_ServiceCredentials = "service_credentials" ImportedCertificateVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the ImportedCertificateVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ImportedCertificateVersion_Alias_Current = "current" ImportedCertificateVersion_Alias_Previous = "previous" )
Constants associated with the ImportedCertificateVersion.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 ( ImportedCertificateVersionMetadata_SecretType_Arbitrary = "arbitrary" ImportedCertificateVersionMetadata_SecretType_IamCredentials = "iam_credentials" ImportedCertificateVersionMetadata_SecretType_ImportedCert = "imported_cert" ImportedCertificateVersionMetadata_SecretType_Kv = "kv" ImportedCertificateVersionMetadata_SecretType_PrivateCert = "private_cert" ImportedCertificateVersionMetadata_SecretType_PublicCert = "public_cert" ImportedCertificateVersionMetadata_SecretType_ServiceCredentials = "service_credentials" ImportedCertificateVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the ImportedCertificateVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ImportedCertificateVersionMetadata_Alias_Current = "current" ImportedCertificateVersionMetadata_Alias_Previous = "previous" )
Constants associated with the ImportedCertificateVersionMetadata.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 ( KVSecret_SecretType_Arbitrary = "arbitrary" KVSecret_SecretType_IamCredentials = "iam_credentials" KVSecret_SecretType_ImportedCert = "imported_cert" KVSecret_SecretType_Kv = "kv" KVSecret_SecretType_PrivateCert = "private_cert" KVSecret_SecretType_PublicCert = "public_cert" KVSecret_SecretType_ServiceCredentials = "service_credentials" KVSecret_SecretType_UsernamePassword = "username_password" )
Constants associated with the KVSecret.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( KVSecret_StateDescription_Active = "active" KVSecret_StateDescription_Deactivated = "deactivated" KVSecret_StateDescription_Destroyed = "destroyed" KVSecret_StateDescription_PreActivation = "pre_activation" KVSecret_StateDescription_Suspended = "suspended" )
Constants associated with the KVSecret.StateDescription property. A text representation of the secret state.
View Source
const ( KVSecretMetadata_SecretType_Arbitrary = "arbitrary" KVSecretMetadata_SecretType_IamCredentials = "iam_credentials" KVSecretMetadata_SecretType_ImportedCert = "imported_cert" KVSecretMetadata_SecretType_Kv = "kv" KVSecretMetadata_SecretType_PrivateCert = "private_cert" KVSecretMetadata_SecretType_PublicCert = "public_cert" KVSecretMetadata_SecretType_ServiceCredentials = "service_credentials" KVSecretMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the KVSecretMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( KVSecretMetadata_StateDescription_Active = "active" KVSecretMetadata_StateDescription_Deactivated = "deactivated" KVSecretMetadata_StateDescription_Destroyed = "destroyed" KVSecretMetadata_StateDescription_PreActivation = "pre_activation" KVSecretMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the KVSecretMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( KVSecretPrototype_SecretType_Arbitrary = "arbitrary" KVSecretPrototype_SecretType_IamCredentials = "iam_credentials" KVSecretPrototype_SecretType_ImportedCert = "imported_cert" KVSecretPrototype_SecretType_Kv = "kv" KVSecretPrototype_SecretType_PrivateCert = "private_cert" KVSecretPrototype_SecretType_PublicCert = "public_cert" KVSecretPrototype_SecretType_ServiceCredentials = "service_credentials" KVSecretPrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the KVSecretPrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( KVSecretVersion_SecretType_Arbitrary = "arbitrary" KVSecretVersion_SecretType_IamCredentials = "iam_credentials" KVSecretVersion_SecretType_ImportedCert = "imported_cert" KVSecretVersion_SecretType_Kv = "kv" KVSecretVersion_SecretType_PrivateCert = "private_cert" KVSecretVersion_SecretType_PublicCert = "public_cert" KVSecretVersion_SecretType_ServiceCredentials = "service_credentials" KVSecretVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the KVSecretVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( KVSecretVersion_Alias_Current = "current" KVSecretVersion_Alias_Previous = "previous" )
Constants associated with the KVSecretVersion.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 ( KVSecretVersionMetadata_SecretType_Arbitrary = "arbitrary" KVSecretVersionMetadata_SecretType_IamCredentials = "iam_credentials" KVSecretVersionMetadata_SecretType_ImportedCert = "imported_cert" KVSecretVersionMetadata_SecretType_Kv = "kv" KVSecretVersionMetadata_SecretType_PrivateCert = "private_cert" KVSecretVersionMetadata_SecretType_PublicCert = "public_cert" KVSecretVersionMetadata_SecretType_ServiceCredentials = "service_credentials" KVSecretVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the KVSecretVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( KVSecretVersionMetadata_Alias_Current = "current" KVSecretVersionMetadata_Alias_Previous = "previous" )
Constants associated with the KVSecretVersionMetadata.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 ( PrivateCertificate_SecretType_Arbitrary = "arbitrary" PrivateCertificate_SecretType_IamCredentials = "iam_credentials" PrivateCertificate_SecretType_ImportedCert = "imported_cert" PrivateCertificate_SecretType_Kv = "kv" PrivateCertificate_SecretType_PrivateCert = "private_cert" PrivateCertificate_SecretType_PublicCert = "public_cert" PrivateCertificate_SecretType_ServiceCredentials = "service_credentials" PrivateCertificate_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificate.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificate_StateDescription_Active = "active" PrivateCertificate_StateDescription_Deactivated = "deactivated" PrivateCertificate_StateDescription_Destroyed = "destroyed" PrivateCertificate_StateDescription_PreActivation = "pre_activation" PrivateCertificate_StateDescription_Suspended = "suspended" )
Constants associated with the PrivateCertificate.StateDescription property. A text representation of the secret state.
View Source
const ( PrivateCertificateActionRevoke_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate" PrivateCertificateActionRevoke_ActionType_PublicCertActionValidateDnsChallenge = "public_cert_action_validate_dns_challenge" )
Constants associated with the PrivateCertificateActionRevoke.ActionType property. The type of secret action.
View Source
const ( PrivateCertificateActionRevokePrototype_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate" PrivateCertificateActionRevokePrototype_ActionType_PublicCertActionValidateDnsChallenge = "public_cert_action_validate_dns_challenge" )
Constants associated with the PrivateCertificateActionRevokePrototype.ActionType property. The type of secret action.
View Source
const ( PrivateCertificateConfigurationActionRevoke_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionRevoke_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionRevoke_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionRevoke_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionRevoke_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionRevoke.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionRevokePrototype_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionRevokePrototype_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionRevokePrototype_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionRevokePrototype_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionRevokePrototype_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionRevokePrototype.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionRotateCRL_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionRotateCRL_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionRotateCRL_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionRotateCRL_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionRotateCRL_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionRotateCRL.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionRotateCRLPrototype_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionRotateCRLPrototype_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionRotateCRLPrototype_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionRotateCRLPrototype_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionRotateCRLPrototype_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionRotateCRLPrototype.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionSetSigned_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionSetSigned_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionSetSigned_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionSetSigned_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionSetSigned_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionSetSigned.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionSetSignedPrototype_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionSetSignedPrototype_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionSetSignedPrototype_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionSetSignedPrototype_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionSetSignedPrototype_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionSetSignedPrototype.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionSignCSR_Format_Pem = "pem" PrivateCertificateConfigurationActionSignCSR_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificateConfigurationActionSignCSR.Format property. The format of the returned data.
View Source
const ( PrivateCertificateConfigurationActionSignCSR_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionSignCSR_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionSignCSR_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionSignCSR_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionSignCSR_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionSignCSR.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionSignCSRPrototype_Format_Pem = "pem" PrivateCertificateConfigurationActionSignCSRPrototype_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificateConfigurationActionSignCSRPrototype.Format property. The format of the returned data.
View Source
const ( PrivateCertificateConfigurationActionSignCSRPrototype_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionSignCSRPrototype_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionSignCSRPrototype_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionSignCSRPrototype_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionSignCSRPrototype_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionSignCSRPrototype.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionSignIntermediate_Format_Pem = "pem" PrivateCertificateConfigurationActionSignIntermediate_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificateConfigurationActionSignIntermediate.Format property. The format of the returned data.
View Source
const ( PrivateCertificateConfigurationActionSignIntermediate_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionSignIntermediate_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionSignIntermediate_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionSignIntermediate_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionSignIntermediate_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionSignIntermediate.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationActionSignIntermediatePrototype_Format_Pem = "pem" PrivateCertificateConfigurationActionSignIntermediatePrototype_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificateConfigurationActionSignIntermediatePrototype.Format property. The format of the returned data.
View Source
const ( PrivateCertificateConfigurationActionSignIntermediatePrototype_ActionType_PrivateCertConfigurationActionRevokeCaCertificate = "private_cert_configuration_action_revoke_ca_certificate" PrivateCertificateConfigurationActionSignIntermediatePrototype_ActionType_PrivateCertConfigurationActionRotateCrl = "private_cert_configuration_action_rotate_crl" PrivateCertificateConfigurationActionSignIntermediatePrototype_ActionType_PrivateCertConfigurationActionSetSigned = "private_cert_configuration_action_set_signed" PrivateCertificateConfigurationActionSignIntermediatePrototype_ActionType_PrivateCertConfigurationActionSignCsr = "private_cert_configuration_action_sign_csr" PrivateCertificateConfigurationActionSignIntermediatePrototype_ActionType_PrivateCertConfigurationActionSignIntermediate = "private_cert_configuration_action_sign_intermediate" )
Constants associated with the PrivateCertificateConfigurationActionSignIntermediatePrototype.ActionType property. The type of configuration action.
View Source
const ( PrivateCertificateConfigurationIntermediateCA_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationIntermediateCA_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationIntermediateCA_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationIntermediateCA_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationIntermediateCA_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationIntermediateCA_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationIntermediateCA_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationIntermediateCA.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationIntermediateCA_SecretType_Arbitrary = "arbitrary" PrivateCertificateConfigurationIntermediateCA_SecretType_IamCredentials = "iam_credentials" PrivateCertificateConfigurationIntermediateCA_SecretType_ImportedCert = "imported_cert" PrivateCertificateConfigurationIntermediateCA_SecretType_Kv = "kv" PrivateCertificateConfigurationIntermediateCA_SecretType_PrivateCert = "private_cert" PrivateCertificateConfigurationIntermediateCA_SecretType_PublicCert = "public_cert" PrivateCertificateConfigurationIntermediateCA_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateConfigurationIntermediateCA_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateConfigurationIntermediateCA.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateConfigurationIntermediateCA_KeyType_Ec = "ec" PrivateCertificateConfigurationIntermediateCA_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationIntermediateCA.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationIntermediateCA_SigningMethod_External = "external" PrivateCertificateConfigurationIntermediateCA_SigningMethod_Internal = "internal" )
Constants associated with the PrivateCertificateConfigurationIntermediateCA.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 ( PrivateCertificateConfigurationIntermediateCA_Status_CertificateTemplateRequired = "certificate_template_required" PrivateCertificateConfigurationIntermediateCA_Status_Configured = "configured" PrivateCertificateConfigurationIntermediateCA_Status_Expired = "expired" PrivateCertificateConfigurationIntermediateCA_Status_Revoked = "revoked" PrivateCertificateConfigurationIntermediateCA_Status_SignedCertificateRequired = "signed_certificate_required" PrivateCertificateConfigurationIntermediateCA_Status_SigningRequired = "signing_required" )
Constants associated with the PrivateCertificateConfigurationIntermediateCA.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 ( PrivateCertificateConfigurationIntermediateCA_Format_Pem = "pem" PrivateCertificateConfigurationIntermediateCA_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificateConfigurationIntermediateCA.Format property. The format of the returned data.
View Source
const ( PrivateCertificateConfigurationIntermediateCA_PrivateKeyFormat_Der = "der" PrivateCertificateConfigurationIntermediateCA_PrivateKeyFormat_Pkcs8 = "pkcs8" )
Constants associated with the PrivateCertificateConfigurationIntermediateCA.PrivateKeyFormat property. The format of the generated private key.
View Source
const ( PrivateCertificateConfigurationIntermediateCACSR_PrivateKeyType_Ec = "ec" PrivateCertificateConfigurationIntermediateCACSR_PrivateKeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationIntermediateCACSR.PrivateKeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationIntermediateCAMetadata_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationIntermediateCAMetadata_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationIntermediateCAMetadata_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationIntermediateCAMetadata_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationIntermediateCAMetadata_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationIntermediateCAMetadata_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationIntermediateCAMetadata_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAMetadata.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationIntermediateCAMetadata_SecretType_Arbitrary = "arbitrary" PrivateCertificateConfigurationIntermediateCAMetadata_SecretType_IamCredentials = "iam_credentials" PrivateCertificateConfigurationIntermediateCAMetadata_SecretType_ImportedCert = "imported_cert" PrivateCertificateConfigurationIntermediateCAMetadata_SecretType_Kv = "kv" PrivateCertificateConfigurationIntermediateCAMetadata_SecretType_PrivateCert = "private_cert" PrivateCertificateConfigurationIntermediateCAMetadata_SecretType_PublicCert = "public_cert" PrivateCertificateConfigurationIntermediateCAMetadata_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateConfigurationIntermediateCAMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateConfigurationIntermediateCAMetadata_KeyType_Ec = "ec" PrivateCertificateConfigurationIntermediateCAMetadata_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAMetadata.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationIntermediateCAMetadata_SigningMethod_External = "external" PrivateCertificateConfigurationIntermediateCAMetadata_SigningMethod_Internal = "internal" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAMetadata.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 ( PrivateCertificateConfigurationIntermediateCAMetadata_Status_CertificateTemplateRequired = "certificate_template_required" PrivateCertificateConfigurationIntermediateCAMetadata_Status_Configured = "configured" PrivateCertificateConfigurationIntermediateCAMetadata_Status_Expired = "expired" PrivateCertificateConfigurationIntermediateCAMetadata_Status_Revoked = "revoked" PrivateCertificateConfigurationIntermediateCAMetadata_Status_SignedCertificateRequired = "signed_certificate_required" PrivateCertificateConfigurationIntermediateCAMetadata_Status_SigningRequired = "signing_required" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAMetadata.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 ( PrivateCertificateConfigurationIntermediateCAPrototype_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationIntermediateCAPrototype_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationIntermediateCAPrototype_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationIntermediateCAPrototype_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationIntermediateCAPrototype_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationIntermediateCAPrototype_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationIntermediateCAPrototype_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAPrototype.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationIntermediateCAPrototype_SigningMethod_External = "external" PrivateCertificateConfigurationIntermediateCAPrototype_SigningMethod_Internal = "internal" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAPrototype.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 ( PrivateCertificateConfigurationIntermediateCAPrototype_Format_Pem = "pem" PrivateCertificateConfigurationIntermediateCAPrototype_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAPrototype.Format property. The format of the returned data.
View Source
const ( PrivateCertificateConfigurationIntermediateCAPrototype_PrivateKeyFormat_Der = "der" PrivateCertificateConfigurationIntermediateCAPrototype_PrivateKeyFormat_Pkcs8 = "pkcs8" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAPrototype.PrivateKeyFormat property. The format of the generated private key.
View Source
const ( PrivateCertificateConfigurationIntermediateCAPrototype_KeyType_Ec = "ec" PrivateCertificateConfigurationIntermediateCAPrototype_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationIntermediateCAPrototype.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationRootCA_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationRootCA_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationRootCA_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationRootCA_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationRootCA_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationRootCA_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationRootCA_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationRootCA.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationRootCA_SecretType_Arbitrary = "arbitrary" PrivateCertificateConfigurationRootCA_SecretType_IamCredentials = "iam_credentials" PrivateCertificateConfigurationRootCA_SecretType_ImportedCert = "imported_cert" PrivateCertificateConfigurationRootCA_SecretType_Kv = "kv" PrivateCertificateConfigurationRootCA_SecretType_PrivateCert = "private_cert" PrivateCertificateConfigurationRootCA_SecretType_PublicCert = "public_cert" PrivateCertificateConfigurationRootCA_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateConfigurationRootCA_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateConfigurationRootCA.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateConfigurationRootCA_KeyType_Ec = "ec" PrivateCertificateConfigurationRootCA_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationRootCA.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationRootCA_Status_CertificateTemplateRequired = "certificate_template_required" PrivateCertificateConfigurationRootCA_Status_Configured = "configured" PrivateCertificateConfigurationRootCA_Status_Expired = "expired" PrivateCertificateConfigurationRootCA_Status_Revoked = "revoked" PrivateCertificateConfigurationRootCA_Status_SignedCertificateRequired = "signed_certificate_required" PrivateCertificateConfigurationRootCA_Status_SigningRequired = "signing_required" )
Constants associated with the PrivateCertificateConfigurationRootCA.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 ( PrivateCertificateConfigurationRootCA_Format_Pem = "pem" PrivateCertificateConfigurationRootCA_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificateConfigurationRootCA.Format property. The format of the returned data.
View Source
const ( PrivateCertificateConfigurationRootCA_PrivateKeyFormat_Der = "der" PrivateCertificateConfigurationRootCA_PrivateKeyFormat_Pkcs8 = "pkcs8" )
Constants associated with the PrivateCertificateConfigurationRootCA.PrivateKeyFormat property. The format of the generated private key.
View Source
const ( PrivateCertificateConfigurationRootCAMetadata_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationRootCAMetadata_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationRootCAMetadata_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationRootCAMetadata_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationRootCAMetadata_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationRootCAMetadata_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationRootCAMetadata_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationRootCAMetadata.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationRootCAMetadata_SecretType_Arbitrary = "arbitrary" PrivateCertificateConfigurationRootCAMetadata_SecretType_IamCredentials = "iam_credentials" PrivateCertificateConfigurationRootCAMetadata_SecretType_ImportedCert = "imported_cert" PrivateCertificateConfigurationRootCAMetadata_SecretType_Kv = "kv" PrivateCertificateConfigurationRootCAMetadata_SecretType_PrivateCert = "private_cert" PrivateCertificateConfigurationRootCAMetadata_SecretType_PublicCert = "public_cert" PrivateCertificateConfigurationRootCAMetadata_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateConfigurationRootCAMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateConfigurationRootCAMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateConfigurationRootCAMetadata_KeyType_Ec = "ec" PrivateCertificateConfigurationRootCAMetadata_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationRootCAMetadata.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationRootCAMetadata_Status_CertificateTemplateRequired = "certificate_template_required" PrivateCertificateConfigurationRootCAMetadata_Status_Configured = "configured" PrivateCertificateConfigurationRootCAMetadata_Status_Expired = "expired" PrivateCertificateConfigurationRootCAMetadata_Status_Revoked = "revoked" PrivateCertificateConfigurationRootCAMetadata_Status_SignedCertificateRequired = "signed_certificate_required" PrivateCertificateConfigurationRootCAMetadata_Status_SigningRequired = "signing_required" )
Constants associated with the PrivateCertificateConfigurationRootCAMetadata.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 ( PrivateCertificateConfigurationRootCAPrototype_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationRootCAPrototype_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationRootCAPrototype_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationRootCAPrototype_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationRootCAPrototype_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationRootCAPrototype_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationRootCAPrototype_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationRootCAPrototype.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationRootCAPrototype_Format_Pem = "pem" PrivateCertificateConfigurationRootCAPrototype_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificateConfigurationRootCAPrototype.Format property. The format of the returned data.
View Source
const ( PrivateCertificateConfigurationRootCAPrototype_PrivateKeyFormat_Der = "der" PrivateCertificateConfigurationRootCAPrototype_PrivateKeyFormat_Pkcs8 = "pkcs8" )
Constants associated with the PrivateCertificateConfigurationRootCAPrototype.PrivateKeyFormat property. The format of the generated private key.
View Source
const ( PrivateCertificateConfigurationRootCAPrototype_KeyType_Ec = "ec" PrivateCertificateConfigurationRootCAPrototype_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationRootCAPrototype.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationTemplate_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationTemplate_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationTemplate_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationTemplate_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationTemplate_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationTemplate_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationTemplate_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationTemplate.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationTemplate_SecretType_Arbitrary = "arbitrary" PrivateCertificateConfigurationTemplate_SecretType_IamCredentials = "iam_credentials" PrivateCertificateConfigurationTemplate_SecretType_ImportedCert = "imported_cert" PrivateCertificateConfigurationTemplate_SecretType_Kv = "kv" PrivateCertificateConfigurationTemplate_SecretType_PrivateCert = "private_cert" PrivateCertificateConfigurationTemplate_SecretType_PublicCert = "public_cert" PrivateCertificateConfigurationTemplate_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateConfigurationTemplate_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateConfigurationTemplate.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateConfigurationTemplate_KeyType_Ec = "ec" PrivateCertificateConfigurationTemplate_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationTemplate.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationTemplateMetadata_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationTemplateMetadata_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationTemplateMetadata_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationTemplateMetadata_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationTemplateMetadata_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationTemplateMetadata_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationTemplateMetadata_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationTemplateMetadata.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationTemplateMetadata_SecretType_Arbitrary = "arbitrary" PrivateCertificateConfigurationTemplateMetadata_SecretType_IamCredentials = "iam_credentials" PrivateCertificateConfigurationTemplateMetadata_SecretType_ImportedCert = "imported_cert" PrivateCertificateConfigurationTemplateMetadata_SecretType_Kv = "kv" PrivateCertificateConfigurationTemplateMetadata_SecretType_PrivateCert = "private_cert" PrivateCertificateConfigurationTemplateMetadata_SecretType_PublicCert = "public_cert" PrivateCertificateConfigurationTemplateMetadata_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateConfigurationTemplateMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateConfigurationTemplateMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateConfigurationTemplatePatch_KeyType_Ec = "ec" PrivateCertificateConfigurationTemplatePatch_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationTemplatePatch.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateConfigurationTemplatePrototype_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PrivateCertificateConfigurationTemplatePrototype_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PrivateCertificateConfigurationTemplatePrototype_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PrivateCertificateConfigurationTemplatePrototype_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PrivateCertificateConfigurationTemplatePrototype_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PrivateCertificateConfigurationTemplatePrototype_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PrivateCertificateConfigurationTemplatePrototype_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PrivateCertificateConfigurationTemplatePrototype.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PrivateCertificateConfigurationTemplatePrototype_KeyType_Ec = "ec" PrivateCertificateConfigurationTemplatePrototype_KeyType_Rsa = "rsa" )
Constants associated with the PrivateCertificateConfigurationTemplatePrototype.KeyType property. The type of private key to generate.
View Source
const ( PrivateCertificateMetadata_SecretType_Arbitrary = "arbitrary" PrivateCertificateMetadata_SecretType_IamCredentials = "iam_credentials" PrivateCertificateMetadata_SecretType_ImportedCert = "imported_cert" PrivateCertificateMetadata_SecretType_Kv = "kv" PrivateCertificateMetadata_SecretType_PrivateCert = "private_cert" PrivateCertificateMetadata_SecretType_PublicCert = "public_cert" PrivateCertificateMetadata_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateMetadata_StateDescription_Active = "active" PrivateCertificateMetadata_StateDescription_Deactivated = "deactivated" PrivateCertificateMetadata_StateDescription_Destroyed = "destroyed" PrivateCertificateMetadata_StateDescription_PreActivation = "pre_activation" PrivateCertificateMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the PrivateCertificateMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( PrivateCertificatePrototype_SecretType_Arbitrary = "arbitrary" PrivateCertificatePrototype_SecretType_IamCredentials = "iam_credentials" PrivateCertificatePrototype_SecretType_ImportedCert = "imported_cert" PrivateCertificatePrototype_SecretType_Kv = "kv" PrivateCertificatePrototype_SecretType_PrivateCert = "private_cert" PrivateCertificatePrototype_SecretType_PublicCert = "public_cert" PrivateCertificatePrototype_SecretType_ServiceCredentials = "service_credentials" PrivateCertificatePrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificatePrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificatePrototype_Format_Pem = "pem" PrivateCertificatePrototype_Format_PemBundle = "pem_bundle" )
Constants associated with the PrivateCertificatePrototype.Format property. The format of the returned data.
View Source
const ( PrivateCertificatePrototype_PrivateKeyFormat_Der = "der" PrivateCertificatePrototype_PrivateKeyFormat_Pkcs8 = "pkcs8" )
Constants associated with the PrivateCertificatePrototype.PrivateKeyFormat property. The format of the generated private key.
View Source
const ( PrivateCertificateVersion_SecretType_Arbitrary = "arbitrary" PrivateCertificateVersion_SecretType_IamCredentials = "iam_credentials" PrivateCertificateVersion_SecretType_ImportedCert = "imported_cert" PrivateCertificateVersion_SecretType_Kv = "kv" PrivateCertificateVersion_SecretType_PrivateCert = "private_cert" PrivateCertificateVersion_SecretType_PublicCert = "public_cert" PrivateCertificateVersion_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateVersion_Alias_Current = "current" PrivateCertificateVersion_Alias_Previous = "previous" )
Constants associated with the PrivateCertificateVersion.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 ( PrivateCertificateVersionMetadata_SecretType_Arbitrary = "arbitrary" PrivateCertificateVersionMetadata_SecretType_IamCredentials = "iam_credentials" PrivateCertificateVersionMetadata_SecretType_ImportedCert = "imported_cert" PrivateCertificateVersionMetadata_SecretType_Kv = "kv" PrivateCertificateVersionMetadata_SecretType_PrivateCert = "private_cert" PrivateCertificateVersionMetadata_SecretType_PublicCert = "public_cert" PrivateCertificateVersionMetadata_SecretType_ServiceCredentials = "service_credentials" PrivateCertificateVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PrivateCertificateVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PrivateCertificateVersionMetadata_Alias_Current = "current" PrivateCertificateVersionMetadata_Alias_Previous = "previous" )
Constants associated with the PrivateCertificateVersionMetadata.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 ( PublicCertificate_SecretType_Arbitrary = "arbitrary" PublicCertificate_SecretType_IamCredentials = "iam_credentials" PublicCertificate_SecretType_ImportedCert = "imported_cert" PublicCertificate_SecretType_Kv = "kv" PublicCertificate_SecretType_PrivateCert = "private_cert" PublicCertificate_SecretType_PublicCert = "public_cert" PublicCertificate_SecretType_ServiceCredentials = "service_credentials" PublicCertificate_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificate.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificate_StateDescription_Active = "active" PublicCertificate_StateDescription_Deactivated = "deactivated" PublicCertificate_StateDescription_Destroyed = "destroyed" PublicCertificate_StateDescription_PreActivation = "pre_activation" PublicCertificate_StateDescription_Suspended = "suspended" )
Constants associated with the PublicCertificate.StateDescription property. A text representation of the secret state.
View Source
const ( PublicCertificateActionValidateManualDNS_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate" PublicCertificateActionValidateManualDNS_ActionType_PublicCertActionValidateDnsChallenge = "public_cert_action_validate_dns_challenge" )
Constants associated with the PublicCertificateActionValidateManualDNS.ActionType property. The type of secret action.
View Source
const ( PublicCertificateActionValidateManualDNSPrototype_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate" PublicCertificateActionValidateManualDNSPrototype_ActionType_PublicCertActionValidateDnsChallenge = "public_cert_action_validate_dns_challenge" )
Constants associated with the PublicCertificateActionValidateManualDNSPrototype.ActionType property. The type of secret action.
View Source
const ( PublicCertificateConfigurationCALetsEncrypt_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationCALetsEncrypt_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationCALetsEncrypt_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationCALetsEncrypt_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationCALetsEncrypt_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationCALetsEncrypt_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationCALetsEncrypt_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationCALetsEncrypt.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateConfigurationCALetsEncrypt_SecretType_Arbitrary = "arbitrary" PublicCertificateConfigurationCALetsEncrypt_SecretType_IamCredentials = "iam_credentials" PublicCertificateConfigurationCALetsEncrypt_SecretType_ImportedCert = "imported_cert" PublicCertificateConfigurationCALetsEncrypt_SecretType_Kv = "kv" PublicCertificateConfigurationCALetsEncrypt_SecretType_PrivateCert = "private_cert" PublicCertificateConfigurationCALetsEncrypt_SecretType_PublicCert = "public_cert" PublicCertificateConfigurationCALetsEncrypt_SecretType_ServiceCredentials = "service_credentials" PublicCertificateConfigurationCALetsEncrypt_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateConfigurationCALetsEncrypt.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateConfigurationCALetsEncrypt_LetsEncryptEnvironment_Production = "production" PublicCertificateConfigurationCALetsEncrypt_LetsEncryptEnvironment_Staging = "staging" )
Constants associated with the PublicCertificateConfigurationCALetsEncrypt.LetsEncryptEnvironment property. The configuration of the Let's Encrypt CA environment.
View Source
const ( PublicCertificateConfigurationCALetsEncryptMetadata_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationCALetsEncryptMetadata_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationCALetsEncryptMetadata_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationCALetsEncryptMetadata_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationCALetsEncryptMetadata_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationCALetsEncryptMetadata_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationCALetsEncryptMetadata_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationCALetsEncryptMetadata.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateConfigurationCALetsEncryptMetadata_SecretType_Arbitrary = "arbitrary" PublicCertificateConfigurationCALetsEncryptMetadata_SecretType_IamCredentials = "iam_credentials" PublicCertificateConfigurationCALetsEncryptMetadata_SecretType_ImportedCert = "imported_cert" PublicCertificateConfigurationCALetsEncryptMetadata_SecretType_Kv = "kv" PublicCertificateConfigurationCALetsEncryptMetadata_SecretType_PrivateCert = "private_cert" PublicCertificateConfigurationCALetsEncryptMetadata_SecretType_PublicCert = "public_cert" PublicCertificateConfigurationCALetsEncryptMetadata_SecretType_ServiceCredentials = "service_credentials" PublicCertificateConfigurationCALetsEncryptMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateConfigurationCALetsEncryptMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateConfigurationCALetsEncryptMetadata_LetsEncryptEnvironment_Production = "production" PublicCertificateConfigurationCALetsEncryptMetadata_LetsEncryptEnvironment_Staging = "staging" )
Constants associated with the PublicCertificateConfigurationCALetsEncryptMetadata.LetsEncryptEnvironment property. The configuration of the Let's Encrypt CA environment.
View Source
const ( PublicCertificateConfigurationCALetsEncryptPatch_LetsEncryptEnvironment_Production = "production" PublicCertificateConfigurationCALetsEncryptPatch_LetsEncryptEnvironment_Staging = "staging" )
Constants associated with the PublicCertificateConfigurationCALetsEncryptPatch.LetsEncryptEnvironment property. The configuration of the Let's Encrypt CA environment.
View Source
const ( PublicCertificateConfigurationCALetsEncryptPrototype_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationCALetsEncryptPrototype_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationCALetsEncryptPrototype_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationCALetsEncryptPrototype_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationCALetsEncryptPrototype_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationCALetsEncryptPrototype_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationCALetsEncryptPrototype_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationCALetsEncryptPrototype.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateConfigurationCALetsEncryptPrototype_LetsEncryptEnvironment_Production = "production" PublicCertificateConfigurationCALetsEncryptPrototype_LetsEncryptEnvironment_Staging = "staging" )
Constants associated with the PublicCertificateConfigurationCALetsEncryptPrototype.LetsEncryptEnvironment property. The configuration of the Let's Encrypt CA environment.
View Source
const ( PublicCertificateConfigurationDNSClassicInfrastructure_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationDNSClassicInfrastructure_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationDNSClassicInfrastructure_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationDNSClassicInfrastructure_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationDNSClassicInfrastructure_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationDNSClassicInfrastructure_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationDNSClassicInfrastructure_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationDNSClassicInfrastructure.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateConfigurationDNSClassicInfrastructure_SecretType_Arbitrary = "arbitrary" PublicCertificateConfigurationDNSClassicInfrastructure_SecretType_IamCredentials = "iam_credentials" PublicCertificateConfigurationDNSClassicInfrastructure_SecretType_ImportedCert = "imported_cert" PublicCertificateConfigurationDNSClassicInfrastructure_SecretType_Kv = "kv" PublicCertificateConfigurationDNSClassicInfrastructure_SecretType_PrivateCert = "private_cert" PublicCertificateConfigurationDNSClassicInfrastructure_SecretType_PublicCert = "public_cert" PublicCertificateConfigurationDNSClassicInfrastructure_SecretType_ServiceCredentials = "service_credentials" PublicCertificateConfigurationDNSClassicInfrastructure_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateConfigurationDNSClassicInfrastructure.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateConfigurationDNSClassicInfrastructureMetadata_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationDNSClassicInfrastructureMetadata.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateConfigurationDNSClassicInfrastructureMetadata_SecretType_Arbitrary = "arbitrary" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_SecretType_IamCredentials = "iam_credentials" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_SecretType_ImportedCert = "imported_cert" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_SecretType_Kv = "kv" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_SecretType_PrivateCert = "private_cert" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_SecretType_PublicCert = "public_cert" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_SecretType_ServiceCredentials = "service_credentials" PublicCertificateConfigurationDNSClassicInfrastructureMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateConfigurationDNSClassicInfrastructureMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateConfigurationDNSClassicInfrastructurePrototype_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationDNSClassicInfrastructurePrototype_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationDNSClassicInfrastructurePrototype_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationDNSClassicInfrastructurePrototype_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationDNSClassicInfrastructurePrototype_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationDNSClassicInfrastructurePrototype_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationDNSClassicInfrastructurePrototype_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationDNSClassicInfrastructurePrototype.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateConfigurationDNSCloudInternetServices_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationDNSCloudInternetServices_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationDNSCloudInternetServices_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationDNSCloudInternetServices_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationDNSCloudInternetServices_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationDNSCloudInternetServices_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationDNSCloudInternetServices_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationDNSCloudInternetServices.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateConfigurationDNSCloudInternetServices_SecretType_Arbitrary = "arbitrary" PublicCertificateConfigurationDNSCloudInternetServices_SecretType_IamCredentials = "iam_credentials" PublicCertificateConfigurationDNSCloudInternetServices_SecretType_ImportedCert = "imported_cert" PublicCertificateConfigurationDNSCloudInternetServices_SecretType_Kv = "kv" PublicCertificateConfigurationDNSCloudInternetServices_SecretType_PrivateCert = "private_cert" PublicCertificateConfigurationDNSCloudInternetServices_SecretType_PublicCert = "public_cert" PublicCertificateConfigurationDNSCloudInternetServices_SecretType_ServiceCredentials = "service_credentials" PublicCertificateConfigurationDNSCloudInternetServices_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateConfigurationDNSCloudInternetServices.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateConfigurationDNSCloudInternetServicesMetadata_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationDNSCloudInternetServicesMetadata.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateConfigurationDNSCloudInternetServicesMetadata_SecretType_Arbitrary = "arbitrary" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_SecretType_IamCredentials = "iam_credentials" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_SecretType_ImportedCert = "imported_cert" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_SecretType_Kv = "kv" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_SecretType_PrivateCert = "private_cert" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_SecretType_PublicCert = "public_cert" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_SecretType_ServiceCredentials = "service_credentials" PublicCertificateConfigurationDNSCloudInternetServicesMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateConfigurationDNSCloudInternetServicesMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateConfigurationDNSCloudInternetServicesPrototype_ConfigType_IamCredentialsConfiguration = "iam_credentials_configuration" PublicCertificateConfigurationDNSCloudInternetServicesPrototype_ConfigType_PrivateCertConfigurationIntermediateCa = "private_cert_configuration_intermediate_ca" PublicCertificateConfigurationDNSCloudInternetServicesPrototype_ConfigType_PrivateCertConfigurationRootCa = "private_cert_configuration_root_ca" PublicCertificateConfigurationDNSCloudInternetServicesPrototype_ConfigType_PrivateCertConfigurationTemplate = "private_cert_configuration_template" PublicCertificateConfigurationDNSCloudInternetServicesPrototype_ConfigType_PublicCertConfigurationCaLetsEncrypt = "public_cert_configuration_ca_lets_encrypt" PublicCertificateConfigurationDNSCloudInternetServicesPrototype_ConfigType_PublicCertConfigurationDnsClassicInfrastructure = "public_cert_configuration_dns_classic_infrastructure" PublicCertificateConfigurationDNSCloudInternetServicesPrototype_ConfigType_PublicCertConfigurationDnsCloudInternetServices = "public_cert_configuration_dns_cloud_internet_services" )
Constants associated with the PublicCertificateConfigurationDNSCloudInternetServicesPrototype.ConfigType property. The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
View Source
const ( PublicCertificateMetadata_SecretType_Arbitrary = "arbitrary" PublicCertificateMetadata_SecretType_IamCredentials = "iam_credentials" PublicCertificateMetadata_SecretType_ImportedCert = "imported_cert" PublicCertificateMetadata_SecretType_Kv = "kv" PublicCertificateMetadata_SecretType_PrivateCert = "private_cert" PublicCertificateMetadata_SecretType_PublicCert = "public_cert" PublicCertificateMetadata_SecretType_ServiceCredentials = "service_credentials" PublicCertificateMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateMetadata_StateDescription_Active = "active" PublicCertificateMetadata_StateDescription_Deactivated = "deactivated" PublicCertificateMetadata_StateDescription_Destroyed = "destroyed" PublicCertificateMetadata_StateDescription_PreActivation = "pre_activation" PublicCertificateMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the PublicCertificateMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( PublicCertificatePrototype_SecretType_Arbitrary = "arbitrary" PublicCertificatePrototype_SecretType_IamCredentials = "iam_credentials" PublicCertificatePrototype_SecretType_ImportedCert = "imported_cert" PublicCertificatePrototype_SecretType_Kv = "kv" PublicCertificatePrototype_SecretType_PrivateCert = "private_cert" PublicCertificatePrototype_SecretType_PublicCert = "public_cert" PublicCertificatePrototype_SecretType_ServiceCredentials = "service_credentials" PublicCertificatePrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificatePrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateVersion_SecretType_Arbitrary = "arbitrary" PublicCertificateVersion_SecretType_IamCredentials = "iam_credentials" PublicCertificateVersion_SecretType_ImportedCert = "imported_cert" PublicCertificateVersion_SecretType_Kv = "kv" PublicCertificateVersion_SecretType_PrivateCert = "private_cert" PublicCertificateVersion_SecretType_PublicCert = "public_cert" PublicCertificateVersion_SecretType_ServiceCredentials = "service_credentials" PublicCertificateVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateVersion_Alias_Current = "current" PublicCertificateVersion_Alias_Previous = "previous" )
Constants associated with the PublicCertificateVersion.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 ( PublicCertificateVersionMetadata_SecretType_Arbitrary = "arbitrary" PublicCertificateVersionMetadata_SecretType_IamCredentials = "iam_credentials" PublicCertificateVersionMetadata_SecretType_ImportedCert = "imported_cert" PublicCertificateVersionMetadata_SecretType_Kv = "kv" PublicCertificateVersionMetadata_SecretType_PrivateCert = "private_cert" PublicCertificateVersionMetadata_SecretType_PublicCert = "public_cert" PublicCertificateVersionMetadata_SecretType_ServiceCredentials = "service_credentials" PublicCertificateVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the PublicCertificateVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( PublicCertificateVersionMetadata_Alias_Current = "current" PublicCertificateVersionMetadata_Alias_Previous = "previous" )
Constants associated with the PublicCertificateVersionMetadata.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 ( ServiceCredentialsSecret_SecretType_Arbitrary = "arbitrary" ServiceCredentialsSecret_SecretType_IamCredentials = "iam_credentials" ServiceCredentialsSecret_SecretType_ImportedCert = "imported_cert" ServiceCredentialsSecret_SecretType_Kv = "kv" ServiceCredentialsSecret_SecretType_PrivateCert = "private_cert" ServiceCredentialsSecret_SecretType_PublicCert = "public_cert" ServiceCredentialsSecret_SecretType_ServiceCredentials = "service_credentials" ServiceCredentialsSecret_SecretType_UsernamePassword = "username_password" )
Constants associated with the ServiceCredentialsSecret.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ServiceCredentialsSecret_StateDescription_Active = "active" ServiceCredentialsSecret_StateDescription_Deactivated = "deactivated" ServiceCredentialsSecret_StateDescription_Destroyed = "destroyed" ServiceCredentialsSecret_StateDescription_PreActivation = "pre_activation" ServiceCredentialsSecret_StateDescription_Suspended = "suspended" )
Constants associated with the ServiceCredentialsSecret.StateDescription property. A text representation of the secret state.
View Source
const ( ServiceCredentialsSecretMetadata_SecretType_Arbitrary = "arbitrary" ServiceCredentialsSecretMetadata_SecretType_IamCredentials = "iam_credentials" ServiceCredentialsSecretMetadata_SecretType_ImportedCert = "imported_cert" ServiceCredentialsSecretMetadata_SecretType_Kv = "kv" ServiceCredentialsSecretMetadata_SecretType_PrivateCert = "private_cert" ServiceCredentialsSecretMetadata_SecretType_PublicCert = "public_cert" ServiceCredentialsSecretMetadata_SecretType_ServiceCredentials = "service_credentials" ServiceCredentialsSecretMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the ServiceCredentialsSecretMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ServiceCredentialsSecretMetadata_StateDescription_Active = "active" ServiceCredentialsSecretMetadata_StateDescription_Deactivated = "deactivated" ServiceCredentialsSecretMetadata_StateDescription_Destroyed = "destroyed" ServiceCredentialsSecretMetadata_StateDescription_PreActivation = "pre_activation" ServiceCredentialsSecretMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the ServiceCredentialsSecretMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( ServiceCredentialsSecretPrototype_SecretType_Arbitrary = "arbitrary" ServiceCredentialsSecretPrototype_SecretType_IamCredentials = "iam_credentials" ServiceCredentialsSecretPrototype_SecretType_ImportedCert = "imported_cert" ServiceCredentialsSecretPrototype_SecretType_Kv = "kv" ServiceCredentialsSecretPrototype_SecretType_PrivateCert = "private_cert" ServiceCredentialsSecretPrototype_SecretType_PublicCert = "public_cert" ServiceCredentialsSecretPrototype_SecretType_ServiceCredentials = "service_credentials" ServiceCredentialsSecretPrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the ServiceCredentialsSecretPrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ServiceCredentialsSecretVersion_SecretType_Arbitrary = "arbitrary" ServiceCredentialsSecretVersion_SecretType_IamCredentials = "iam_credentials" ServiceCredentialsSecretVersion_SecretType_ImportedCert = "imported_cert" ServiceCredentialsSecretVersion_SecretType_Kv = "kv" ServiceCredentialsSecretVersion_SecretType_PrivateCert = "private_cert" ServiceCredentialsSecretVersion_SecretType_PublicCert = "public_cert" ServiceCredentialsSecretVersion_SecretType_ServiceCredentials = "service_credentials" ServiceCredentialsSecretVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the ServiceCredentialsSecretVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ServiceCredentialsSecretVersion_Alias_Current = "current" ServiceCredentialsSecretVersion_Alias_Previous = "previous" )
Constants associated with the ServiceCredentialsSecretVersion.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 ( ServiceCredentialsSecretVersionMetadata_SecretType_Arbitrary = "arbitrary" ServiceCredentialsSecretVersionMetadata_SecretType_IamCredentials = "iam_credentials" ServiceCredentialsSecretVersionMetadata_SecretType_ImportedCert = "imported_cert" ServiceCredentialsSecretVersionMetadata_SecretType_Kv = "kv" ServiceCredentialsSecretVersionMetadata_SecretType_PrivateCert = "private_cert" ServiceCredentialsSecretVersionMetadata_SecretType_PublicCert = "public_cert" ServiceCredentialsSecretVersionMetadata_SecretType_ServiceCredentials = "service_credentials" ServiceCredentialsSecretVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the ServiceCredentialsSecretVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( ServiceCredentialsSecretVersionMetadata_Alias_Current = "current" ServiceCredentialsSecretVersionMetadata_Alias_Previous = "previous" )
Constants associated with the ServiceCredentialsSecretVersionMetadata.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 ( UsernamePasswordSecret_SecretType_Arbitrary = "arbitrary" UsernamePasswordSecret_SecretType_IamCredentials = "iam_credentials" UsernamePasswordSecret_SecretType_ImportedCert = "imported_cert" UsernamePasswordSecret_SecretType_Kv = "kv" UsernamePasswordSecret_SecretType_PrivateCert = "private_cert" UsernamePasswordSecret_SecretType_PublicCert = "public_cert" UsernamePasswordSecret_SecretType_ServiceCredentials = "service_credentials" UsernamePasswordSecret_SecretType_UsernamePassword = "username_password" )
Constants associated with the UsernamePasswordSecret.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( UsernamePasswordSecret_StateDescription_Active = "active" UsernamePasswordSecret_StateDescription_Deactivated = "deactivated" UsernamePasswordSecret_StateDescription_Destroyed = "destroyed" UsernamePasswordSecret_StateDescription_PreActivation = "pre_activation" UsernamePasswordSecret_StateDescription_Suspended = "suspended" )
Constants associated with the UsernamePasswordSecret.StateDescription property. A text representation of the secret state.
View Source
const ( UsernamePasswordSecretMetadata_SecretType_Arbitrary = "arbitrary" UsernamePasswordSecretMetadata_SecretType_IamCredentials = "iam_credentials" UsernamePasswordSecretMetadata_SecretType_ImportedCert = "imported_cert" UsernamePasswordSecretMetadata_SecretType_Kv = "kv" UsernamePasswordSecretMetadata_SecretType_PrivateCert = "private_cert" UsernamePasswordSecretMetadata_SecretType_PublicCert = "public_cert" UsernamePasswordSecretMetadata_SecretType_ServiceCredentials = "service_credentials" UsernamePasswordSecretMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the UsernamePasswordSecretMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( UsernamePasswordSecretMetadata_StateDescription_Active = "active" UsernamePasswordSecretMetadata_StateDescription_Deactivated = "deactivated" UsernamePasswordSecretMetadata_StateDescription_Destroyed = "destroyed" UsernamePasswordSecretMetadata_StateDescription_PreActivation = "pre_activation" UsernamePasswordSecretMetadata_StateDescription_Suspended = "suspended" )
Constants associated with the UsernamePasswordSecretMetadata.StateDescription property. A text representation of the secret state.
View Source
const ( UsernamePasswordSecretPrototype_SecretType_Arbitrary = "arbitrary" UsernamePasswordSecretPrototype_SecretType_IamCredentials = "iam_credentials" UsernamePasswordSecretPrototype_SecretType_ImportedCert = "imported_cert" UsernamePasswordSecretPrototype_SecretType_Kv = "kv" UsernamePasswordSecretPrototype_SecretType_PrivateCert = "private_cert" UsernamePasswordSecretPrototype_SecretType_PublicCert = "public_cert" UsernamePasswordSecretPrototype_SecretType_ServiceCredentials = "service_credentials" UsernamePasswordSecretPrototype_SecretType_UsernamePassword = "username_password" )
Constants associated with the UsernamePasswordSecretPrototype.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( UsernamePasswordSecretVersion_SecretType_Arbitrary = "arbitrary" UsernamePasswordSecretVersion_SecretType_IamCredentials = "iam_credentials" UsernamePasswordSecretVersion_SecretType_ImportedCert = "imported_cert" UsernamePasswordSecretVersion_SecretType_Kv = "kv" UsernamePasswordSecretVersion_SecretType_PrivateCert = "private_cert" UsernamePasswordSecretVersion_SecretType_PublicCert = "public_cert" UsernamePasswordSecretVersion_SecretType_ServiceCredentials = "service_credentials" UsernamePasswordSecretVersion_SecretType_UsernamePassword = "username_password" )
Constants associated with the UsernamePasswordSecretVersion.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( UsernamePasswordSecretVersion_Alias_Current = "current" UsernamePasswordSecretVersion_Alias_Previous = "previous" )
Constants associated with the UsernamePasswordSecretVersion.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 ( UsernamePasswordSecretVersionMetadata_SecretType_Arbitrary = "arbitrary" UsernamePasswordSecretVersionMetadata_SecretType_IamCredentials = "iam_credentials" UsernamePasswordSecretVersionMetadata_SecretType_ImportedCert = "imported_cert" UsernamePasswordSecretVersionMetadata_SecretType_Kv = "kv" UsernamePasswordSecretVersionMetadata_SecretType_PrivateCert = "private_cert" UsernamePasswordSecretVersionMetadata_SecretType_PublicCert = "public_cert" UsernamePasswordSecretVersionMetadata_SecretType_ServiceCredentials = "service_credentials" UsernamePasswordSecretVersionMetadata_SecretType_UsernamePassword = "username_password" )
Constants associated with the UsernamePasswordSecretVersionMetadata.SecretType property. The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.
View Source
const ( UsernamePasswordSecretVersionMetadata_Alias_Current = "current" UsernamePasswordSecretVersionMetadata_Alias_Previous = "previous" )
Constants associated with the UsernamePasswordSecretVersionMetadata.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 DefaultServiceName = "secrets_manager"
DefaultServiceName is the default key used to find external configuration information.
View Source
const DefaultServiceURL = "https://provide-here-your-smgr-instanceuuid.us-south.secrets-manager.appdomain.cloud"
DefaultServiceURL is the default URL to make service requests to.
View Source
const ParameterizedServiceURL = "https://{instance_id}.{region}.secrets-manager.appdomain.cloud"
View Source
const (
PrivateCertificateVersionActionRevokePrototype_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate"
)
Constants associated with the PrivateCertificateVersionActionRevokePrototype.ActionType property. The type of secret version action.
View Source
const (
PrivateCertificateVersionActionRevoke_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate"
)
Constants associated with the PrivateCertificateVersionActionRevoke.ActionType property. The type of secret version action.
View Source
const (
SecretVersionActionPrototype_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate"
)
Constants associated with the SecretVersionActionPrototype.ActionType property. The type of secret version action.
View Source
const (
VersionAction_ActionType_PrivateCertActionRevokeCertificate = "private_cert_action_revoke_certificate"
)
Constants associated with the VersionAction.ActionType property. The type of secret version action.
Variables ¶
This section is empty.
Functions ¶
func ConstructServiceURL ¶
ConstructServiceURL constructs a service URL from the parameterized URL.
func GetServiceURLForRegion ¶
GetServiceURLForRegion returns the service URL to be used for the specified region
func UnmarshalArbitrarySecret ¶
func UnmarshalArbitrarySecret(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalArbitrarySecret unmarshals an instance of ArbitrarySecret from the specified map of raw messages.
func UnmarshalArbitrarySecretMetadata ¶
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 UnmarshalArbitrarySecretMetadataPatch ¶
func UnmarshalArbitrarySecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalArbitrarySecretMetadataPatch unmarshals an instance of ArbitrarySecretMetadataPatch from the specified map of raw messages.
func UnmarshalArbitrarySecretPrototype ¶
func UnmarshalArbitrarySecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalArbitrarySecretPrototype unmarshals an instance of ArbitrarySecretPrototype from the specified map of raw messages.
func UnmarshalArbitrarySecretVersion ¶
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 UnmarshalArbitrarySecretVersionMetadata ¶
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 UnmarshalArbitrarySecretVersionPrototype ¶
func UnmarshalArbitrarySecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalArbitrarySecretVersionPrototype unmarshals an instance of ArbitrarySecretVersionPrototype from the specified map of raw messages.
func UnmarshalCertificateIssuanceInfo ¶
func UnmarshalCertificateIssuanceInfo(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCertificateIssuanceInfo unmarshals an instance of CertificateIssuanceInfo from the specified map of raw messages.
func UnmarshalCertificateValidity ¶
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 ¶
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 UnmarshalCommonRotationPolicy ¶
func UnmarshalCommonRotationPolicy(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCommonRotationPolicy unmarshals an instance of CommonRotationPolicy from the specified map of raw messages.
func UnmarshalConfiguration ¶
func UnmarshalConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConfiguration unmarshals an instance of Configuration from the specified map of raw messages.
func UnmarshalConfigurationAction ¶
func UnmarshalConfigurationAction(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConfigurationAction unmarshals an instance of ConfigurationAction from the specified map of raw messages.
func UnmarshalConfigurationActionPrototype ¶
func UnmarshalConfigurationActionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConfigurationActionPrototype unmarshals an instance of ConfigurationActionPrototype from the specified map of raw messages.
func UnmarshalConfigurationMetadata ¶
func UnmarshalConfigurationMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConfigurationMetadata unmarshals an instance of ConfigurationMetadata from the specified map of raw messages.
func UnmarshalConfigurationMetadataPaginatedCollection ¶
func UnmarshalConfigurationMetadataPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConfigurationMetadataPaginatedCollection unmarshals an instance of ConfigurationMetadataPaginatedCollection from the specified map of raw messages.
func UnmarshalConfigurationPatch ¶
func UnmarshalConfigurationPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConfigurationPatch unmarshals an instance of ConfigurationPatch from the specified map of raw messages.
func UnmarshalConfigurationPrototype ¶
func UnmarshalConfigurationPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConfigurationPrototype unmarshals an instance of ConfigurationPrototype from the specified map of raw messages.
func UnmarshalIAMCredentialsConfiguration ¶
func UnmarshalIAMCredentialsConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsConfiguration unmarshals an instance of IAMCredentialsConfiguration from the specified map of raw messages.
func UnmarshalIAMCredentialsConfigurationMetadata ¶
func UnmarshalIAMCredentialsConfigurationMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsConfigurationMetadata unmarshals an instance of IAMCredentialsConfigurationMetadata from the specified map of raw messages.
func UnmarshalIAMCredentialsConfigurationPatch ¶
func UnmarshalIAMCredentialsConfigurationPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsConfigurationPatch unmarshals an instance of IAMCredentialsConfigurationPatch from the specified map of raw messages.
func UnmarshalIAMCredentialsConfigurationPrototype ¶
func UnmarshalIAMCredentialsConfigurationPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsConfigurationPrototype unmarshals an instance of IAMCredentialsConfigurationPrototype from the specified map of raw messages.
func UnmarshalIAMCredentialsSecret ¶
func UnmarshalIAMCredentialsSecret(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsSecret unmarshals an instance of IAMCredentialsSecret from the specified map of raw messages.
func UnmarshalIAMCredentialsSecretMetadata ¶
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 UnmarshalIAMCredentialsSecretMetadataPatch ¶
func UnmarshalIAMCredentialsSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsSecretMetadataPatch unmarshals an instance of IAMCredentialsSecretMetadataPatch from the specified map of raw messages.
func UnmarshalIAMCredentialsSecretPrototype ¶
func UnmarshalIAMCredentialsSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsSecretPrototype unmarshals an instance of IAMCredentialsSecretPrototype from the specified map of raw messages.
func UnmarshalIAMCredentialsSecretRestoreFromVersionPrototype ¶
func UnmarshalIAMCredentialsSecretRestoreFromVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsSecretRestoreFromVersionPrototype unmarshals an instance of IAMCredentialsSecretRestoreFromVersionPrototype from the specified map of raw messages.
func UnmarshalIAMCredentialsSecretVersion ¶
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 UnmarshalIAMCredentialsSecretVersionMetadata ¶
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 UnmarshalIAMCredentialsSecretVersionPrototype ¶
func UnmarshalIAMCredentialsSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIAMCredentialsSecretVersionPrototype unmarshals an instance of IAMCredentialsSecretVersionPrototype from the specified map of raw messages.
func UnmarshalImportedCertificate ¶
func UnmarshalImportedCertificate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalImportedCertificate unmarshals an instance of ImportedCertificate from the specified map of raw messages.
func UnmarshalImportedCertificateMetadata ¶
func UnmarshalImportedCertificateMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalImportedCertificateMetadata unmarshals an instance of ImportedCertificateMetadata from the specified map of raw messages.
func UnmarshalImportedCertificateMetadataPatch ¶
func UnmarshalImportedCertificateMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalImportedCertificateMetadataPatch unmarshals an instance of ImportedCertificateMetadataPatch from the specified map of raw messages.
func UnmarshalImportedCertificatePrototype ¶
func UnmarshalImportedCertificatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalImportedCertificatePrototype unmarshals an instance of ImportedCertificatePrototype from the specified map of raw messages.
func UnmarshalImportedCertificateVersion ¶
func UnmarshalImportedCertificateVersion(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalImportedCertificateVersion unmarshals an instance of ImportedCertificateVersion from the specified map of raw messages.
func UnmarshalImportedCertificateVersionMetadata ¶
func UnmarshalImportedCertificateVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalImportedCertificateVersionMetadata unmarshals an instance of ImportedCertificateVersionMetadata from the specified map of raw messages.
func UnmarshalImportedCertificateVersionPrototype ¶
func UnmarshalImportedCertificateVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalImportedCertificateVersionPrototype unmarshals an instance of ImportedCertificateVersionPrototype from the specified map of raw messages.
func UnmarshalKVSecret ¶
func UnmarshalKVSecret(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalKVSecret unmarshals an instance of KVSecret from the specified map of raw messages.
func UnmarshalKVSecretMetadata ¶
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 UnmarshalKVSecretMetadataPatch ¶
func UnmarshalKVSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalKVSecretMetadataPatch unmarshals an instance of KVSecretMetadataPatch from the specified map of raw messages.
func UnmarshalKVSecretPrototype ¶
func UnmarshalKVSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalKVSecretPrototype unmarshals an instance of KVSecretPrototype from the specified map of raw messages.
func UnmarshalKVSecretVersion ¶
func UnmarshalKVSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalKVSecretVersion unmarshals an instance of KVSecretVersion from the specified map of raw messages.
func UnmarshalKVSecretVersionMetadata ¶
func UnmarshalKVSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalKVSecretVersionMetadata unmarshals an instance of KVSecretVersionMetadata from the specified map of raw messages.
func UnmarshalKVSecretVersionPrototype ¶
func UnmarshalKVSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalKVSecretVersionPrototype unmarshals an instance of KVSecretVersionPrototype from the specified map of raw messages.
func UnmarshalNotificationsRegistration ¶
func UnmarshalNotificationsRegistration(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNotificationsRegistration unmarshals an instance of NotificationsRegistration from the specified map of raw messages.
func UnmarshalPaginatedCollectionFirst ¶
func UnmarshalPaginatedCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPaginatedCollectionFirst unmarshals an instance of PaginatedCollectionFirst from the specified map of raw messages.
func UnmarshalPaginatedCollectionLast ¶
func UnmarshalPaginatedCollectionLast(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPaginatedCollectionLast unmarshals an instance of PaginatedCollectionLast from the specified map of raw messages.
func UnmarshalPaginatedCollectionNext ¶
func UnmarshalPaginatedCollectionNext(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPaginatedCollectionNext unmarshals an instance of PaginatedCollectionNext from the specified map of raw messages.
func UnmarshalPaginatedCollectionPrevious ¶
func UnmarshalPaginatedCollectionPrevious(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPaginatedCollectionPrevious unmarshals an instance of PaginatedCollectionPrevious from the specified map of raw messages.
func UnmarshalPasswordGenerationPolicy ¶ added in v2.0.3
func UnmarshalPasswordGenerationPolicy(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPasswordGenerationPolicy unmarshals an instance of PasswordGenerationPolicy from the specified map of raw messages.
func UnmarshalPasswordGenerationPolicyPatch ¶ added in v2.0.3
func UnmarshalPasswordGenerationPolicyPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPasswordGenerationPolicyPatch unmarshals an instance of PasswordGenerationPolicyPatch from the specified map of raw messages.
func UnmarshalPasswordGenerationPolicyRO ¶ added in v2.0.3
func UnmarshalPasswordGenerationPolicyRO(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPasswordGenerationPolicyRO unmarshals an instance of PasswordGenerationPolicyRO from the specified map of raw messages.
func UnmarshalPrivateCertificate ¶
func UnmarshalPrivateCertificate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificate unmarshals an instance of PrivateCertificate from the specified map of raw messages.
func UnmarshalPrivateCertificateActionRevoke ¶
func UnmarshalPrivateCertificateActionRevoke(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateActionRevoke unmarshals an instance of PrivateCertificateActionRevoke from the specified map of raw messages.
func UnmarshalPrivateCertificateActionRevokePrototype ¶
func UnmarshalPrivateCertificateActionRevokePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateActionRevokePrototype unmarshals an instance of PrivateCertificateActionRevokePrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateCAData ¶
func UnmarshalPrivateCertificateCAData(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateCAData unmarshals an instance of PrivateCertificateCAData from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionRevoke ¶
func UnmarshalPrivateCertificateConfigurationActionRevoke(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionRevoke unmarshals an instance of PrivateCertificateConfigurationActionRevoke from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionRevokePrototype ¶
func UnmarshalPrivateCertificateConfigurationActionRevokePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionRevokePrototype unmarshals an instance of PrivateCertificateConfigurationActionRevokePrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionRotateCRL ¶
func UnmarshalPrivateCertificateConfigurationActionRotateCRL(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionRotateCRL unmarshals an instance of PrivateCertificateConfigurationActionRotateCRL from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionRotateCRLPrototype ¶
func UnmarshalPrivateCertificateConfigurationActionRotateCRLPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionRotateCRLPrototype unmarshals an instance of PrivateCertificateConfigurationActionRotateCRLPrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionSetSigned ¶
func UnmarshalPrivateCertificateConfigurationActionSetSigned(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionSetSigned unmarshals an instance of PrivateCertificateConfigurationActionSetSigned from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionSetSignedPrototype ¶
func UnmarshalPrivateCertificateConfigurationActionSetSignedPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionSetSignedPrototype unmarshals an instance of PrivateCertificateConfigurationActionSetSignedPrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionSignCSR ¶
func UnmarshalPrivateCertificateConfigurationActionSignCSR(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionSignCSR unmarshals an instance of PrivateCertificateConfigurationActionSignCSR from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionSignCSRPrototype ¶
func UnmarshalPrivateCertificateConfigurationActionSignCSRPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionSignCSRPrototype unmarshals an instance of PrivateCertificateConfigurationActionSignCSRPrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionSignIntermediate ¶
func UnmarshalPrivateCertificateConfigurationActionSignIntermediate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionSignIntermediate unmarshals an instance of PrivateCertificateConfigurationActionSignIntermediate from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationActionSignIntermediatePrototype ¶
func UnmarshalPrivateCertificateConfigurationActionSignIntermediatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationActionSignIntermediatePrototype unmarshals an instance of PrivateCertificateConfigurationActionSignIntermediatePrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationCACertificate ¶
func UnmarshalPrivateCertificateConfigurationCACertificate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationCACertificate unmarshals an instance of PrivateCertificateConfigurationCACertificate from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationIntermediateCA ¶
func UnmarshalPrivateCertificateConfigurationIntermediateCA(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationIntermediateCA unmarshals an instance of PrivateCertificateConfigurationIntermediateCA from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationIntermediateCACSR ¶
func UnmarshalPrivateCertificateConfigurationIntermediateCACSR(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationIntermediateCACSR unmarshals an instance of PrivateCertificateConfigurationIntermediateCACSR from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationIntermediateCAMetadata ¶
func UnmarshalPrivateCertificateConfigurationIntermediateCAMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationIntermediateCAMetadata unmarshals an instance of PrivateCertificateConfigurationIntermediateCAMetadata from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationIntermediateCAPatch ¶
func UnmarshalPrivateCertificateConfigurationIntermediateCAPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationIntermediateCAPatch unmarshals an instance of PrivateCertificateConfigurationIntermediateCAPatch from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationIntermediateCAPrototype ¶
func UnmarshalPrivateCertificateConfigurationIntermediateCAPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationIntermediateCAPrototype unmarshals an instance of PrivateCertificateConfigurationIntermediateCAPrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationRootCA ¶
func UnmarshalPrivateCertificateConfigurationRootCA(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationRootCA unmarshals an instance of PrivateCertificateConfigurationRootCA from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationRootCAMetadata ¶
func UnmarshalPrivateCertificateConfigurationRootCAMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationRootCAMetadata unmarshals an instance of PrivateCertificateConfigurationRootCAMetadata from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationRootCAPatch ¶
func UnmarshalPrivateCertificateConfigurationRootCAPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationRootCAPatch unmarshals an instance of PrivateCertificateConfigurationRootCAPatch from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationRootCAPrototype ¶
func UnmarshalPrivateCertificateConfigurationRootCAPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationRootCAPrototype unmarshals an instance of PrivateCertificateConfigurationRootCAPrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationTemplate ¶
func UnmarshalPrivateCertificateConfigurationTemplate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationTemplate unmarshals an instance of PrivateCertificateConfigurationTemplate from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationTemplateMetadata ¶
func UnmarshalPrivateCertificateConfigurationTemplateMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationTemplateMetadata unmarshals an instance of PrivateCertificateConfigurationTemplateMetadata from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationTemplatePatch ¶
func UnmarshalPrivateCertificateConfigurationTemplatePatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationTemplatePatch unmarshals an instance of PrivateCertificateConfigurationTemplatePatch from the specified map of raw messages.
func UnmarshalPrivateCertificateConfigurationTemplatePrototype ¶
func UnmarshalPrivateCertificateConfigurationTemplatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateConfigurationTemplatePrototype unmarshals an instance of PrivateCertificateConfigurationTemplatePrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateMetadata ¶
func UnmarshalPrivateCertificateMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateMetadata unmarshals an instance of PrivateCertificateMetadata from the specified map of raw messages.
func UnmarshalPrivateCertificateMetadataPatch ¶
func UnmarshalPrivateCertificateMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateMetadataPatch unmarshals an instance of PrivateCertificateMetadataPatch from the specified map of raw messages.
func UnmarshalPrivateCertificatePrototype ¶
func UnmarshalPrivateCertificatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificatePrototype unmarshals an instance of PrivateCertificatePrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateVersion ¶
func UnmarshalPrivateCertificateVersion(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateVersion unmarshals an instance of PrivateCertificateVersion from the specified map of raw messages.
func UnmarshalPrivateCertificateVersionActionRevoke ¶
func UnmarshalPrivateCertificateVersionActionRevoke(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateVersionActionRevoke unmarshals an instance of PrivateCertificateVersionActionRevoke from the specified map of raw messages.
func UnmarshalPrivateCertificateVersionActionRevokePrototype ¶
func UnmarshalPrivateCertificateVersionActionRevokePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateVersionActionRevokePrototype unmarshals an instance of PrivateCertificateVersionActionRevokePrototype from the specified map of raw messages.
func UnmarshalPrivateCertificateVersionMetadata ¶
func UnmarshalPrivateCertificateVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateVersionMetadata unmarshals an instance of PrivateCertificateVersionMetadata from the specified map of raw messages.
func UnmarshalPrivateCertificateVersionPrototype ¶
func UnmarshalPrivateCertificateVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPrivateCertificateVersionPrototype unmarshals an instance of PrivateCertificateVersionPrototype from the specified map of raw messages.
func UnmarshalPublicCertificate ¶
func UnmarshalPublicCertificate(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificate unmarshals an instance of PublicCertificate from the specified map of raw messages.
func UnmarshalPublicCertificateActionValidateManualDNS ¶
func UnmarshalPublicCertificateActionValidateManualDNS(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateActionValidateManualDNS unmarshals an instance of PublicCertificateActionValidateManualDNS from the specified map of raw messages.
func UnmarshalPublicCertificateActionValidateManualDNSPrototype ¶
func UnmarshalPublicCertificateActionValidateManualDNSPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateActionValidateManualDNSPrototype unmarshals an instance of PublicCertificateActionValidateManualDNSPrototype from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationCALetsEncrypt ¶
func UnmarshalPublicCertificateConfigurationCALetsEncrypt(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationCALetsEncrypt unmarshals an instance of PublicCertificateConfigurationCALetsEncrypt from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationCALetsEncryptMetadata ¶
func UnmarshalPublicCertificateConfigurationCALetsEncryptMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationCALetsEncryptMetadata unmarshals an instance of PublicCertificateConfigurationCALetsEncryptMetadata from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationCALetsEncryptPatch ¶
func UnmarshalPublicCertificateConfigurationCALetsEncryptPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationCALetsEncryptPatch unmarshals an instance of PublicCertificateConfigurationCALetsEncryptPatch from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationCALetsEncryptPrototype ¶
func UnmarshalPublicCertificateConfigurationCALetsEncryptPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationCALetsEncryptPrototype unmarshals an instance of PublicCertificateConfigurationCALetsEncryptPrototype from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructure ¶
func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructure(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationDNSClassicInfrastructure unmarshals an instance of PublicCertificateConfigurationDNSClassicInfrastructure from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructureMetadata ¶
func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructureMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationDNSClassicInfrastructureMetadata unmarshals an instance of PublicCertificateConfigurationDNSClassicInfrastructureMetadata from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructurePatch ¶
func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructurePatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationDNSClassicInfrastructurePatch unmarshals an instance of PublicCertificateConfigurationDNSClassicInfrastructurePatch from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructurePrototype ¶
func UnmarshalPublicCertificateConfigurationDNSClassicInfrastructurePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationDNSClassicInfrastructurePrototype unmarshals an instance of PublicCertificateConfigurationDNSClassicInfrastructurePrototype from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationDNSCloudInternetServices ¶
func UnmarshalPublicCertificateConfigurationDNSCloudInternetServices(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationDNSCloudInternetServices unmarshals an instance of PublicCertificateConfigurationDNSCloudInternetServices from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesMetadata ¶
func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesMetadata unmarshals an instance of PublicCertificateConfigurationDNSCloudInternetServicesMetadata from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesPatch ¶
func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesPatch unmarshals an instance of PublicCertificateConfigurationDNSCloudInternetServicesPatch from the specified map of raw messages.
func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesPrototype ¶
func UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateConfigurationDNSCloudInternetServicesPrototype unmarshals an instance of PublicCertificateConfigurationDNSCloudInternetServicesPrototype from the specified map of raw messages.
func UnmarshalPublicCertificateMetadata ¶
func UnmarshalPublicCertificateMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateMetadata unmarshals an instance of PublicCertificateMetadata from the specified map of raw messages.
func UnmarshalPublicCertificateMetadataPatch ¶
func UnmarshalPublicCertificateMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateMetadataPatch unmarshals an instance of PublicCertificateMetadataPatch from the specified map of raw messages.
func UnmarshalPublicCertificatePrototype ¶
func UnmarshalPublicCertificatePrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificatePrototype unmarshals an instance of PublicCertificatePrototype from the specified map of raw messages.
func UnmarshalPublicCertificateRotationObject ¶
func UnmarshalPublicCertificateRotationObject(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateRotationObject unmarshals an instance of PublicCertificateRotationObject from the specified map of raw messages.
func UnmarshalPublicCertificateRotationPolicy ¶
func UnmarshalPublicCertificateRotationPolicy(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateRotationPolicy unmarshals an instance of PublicCertificateRotationPolicy from the specified map of raw messages.
func UnmarshalPublicCertificateVersion ¶
func UnmarshalPublicCertificateVersion(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateVersion unmarshals an instance of PublicCertificateVersion from the specified map of raw messages.
func UnmarshalPublicCertificateVersionMetadata ¶
func UnmarshalPublicCertificateVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateVersionMetadata unmarshals an instance of PublicCertificateVersionMetadata from the specified map of raw messages.
func UnmarshalPublicCertificateVersionPrototype ¶
func UnmarshalPublicCertificateVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPublicCertificateVersionPrototype unmarshals an instance of PublicCertificateVersionPrototype from the specified map of raw messages.
func UnmarshalRotationPolicy ¶
func UnmarshalRotationPolicy(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalRotationPolicy unmarshals an instance of RotationPolicy from the specified map of raw messages.
func UnmarshalSecret ¶
func UnmarshalSecret(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecret unmarshals an instance of Secret from the specified map of raw messages.
func UnmarshalSecretAction ¶
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 UnmarshalSecretActionPrototype ¶
func UnmarshalSecretActionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretActionPrototype unmarshals an instance of SecretActionPrototype from the specified map of raw messages.
func UnmarshalSecretGroup ¶
func UnmarshalSecretGroup(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretGroup unmarshals an instance of SecretGroup from the specified map of raw messages.
func UnmarshalSecretGroupCollection ¶
func UnmarshalSecretGroupCollection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretGroupCollection unmarshals an instance of SecretGroupCollection from the specified map of raw messages.
func UnmarshalSecretGroupPatch ¶
func UnmarshalSecretGroupPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretGroupPatch unmarshals an instance of SecretGroupPatch from the specified map of raw messages.
func UnmarshalSecretLock ¶
func UnmarshalSecretLock(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretLock unmarshals an instance of SecretLock from the specified map of raw messages.
func UnmarshalSecretLockPrototype ¶
func UnmarshalSecretLockPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretLockPrototype unmarshals an instance of SecretLockPrototype from the specified map of raw messages.
func UnmarshalSecretLocks ¶
func UnmarshalSecretLocks(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretLocks unmarshals an instance of SecretLocks from the specified map of raw messages.
func UnmarshalSecretLocksPaginatedCollection ¶
func UnmarshalSecretLocksPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretLocksPaginatedCollection unmarshals an instance of SecretLocksPaginatedCollection 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 UnmarshalSecretMetadataPaginatedCollection ¶
func UnmarshalSecretMetadataPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretMetadataPaginatedCollection unmarshals an instance of SecretMetadataPaginatedCollection from the specified map of raw messages.
func UnmarshalSecretMetadataPatch ¶
func UnmarshalSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretMetadataPatch unmarshals an instance of SecretMetadataPatch from the specified map of raw messages.
func UnmarshalSecretPrototype ¶
func UnmarshalSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretPrototype unmarshals an instance of SecretPrototype 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 UnmarshalSecretVersionActionPrototype ¶
func UnmarshalSecretVersionActionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretVersionActionPrototype unmarshals an instance of SecretVersionActionPrototype from the specified map of raw messages.
func UnmarshalSecretVersionLocks ¶
func UnmarshalSecretVersionLocks(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretVersionLocks unmarshals an instance of SecretVersionLocks from the specified map of raw messages.
func UnmarshalSecretVersionLocksPaginatedCollection ¶
func UnmarshalSecretVersionLocksPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretVersionLocksPaginatedCollection unmarshals an instance of SecretVersionLocksPaginatedCollection from the specified map of raw messages.
func UnmarshalSecretVersionMetadata ¶
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 UnmarshalSecretVersionMetadataCollection ¶
func UnmarshalSecretVersionMetadataCollection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretVersionMetadataCollection unmarshals an instance of SecretVersionMetadataCollection from the specified map of raw messages.
func UnmarshalSecretVersionMetadataPatch ¶
func UnmarshalSecretVersionMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretVersionMetadataPatch unmarshals an instance of SecretVersionMetadataPatch from the specified map of raw messages.
func UnmarshalSecretVersionPrototype ¶
func UnmarshalSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretVersionPrototype unmarshals an instance of SecretVersionPrototype from the specified map of raw messages.
func UnmarshalSecretsLocksPaginatedCollection ¶
func UnmarshalSecretsLocksPaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSecretsLocksPaginatedCollection unmarshals an instance of SecretsLocksPaginatedCollection from the specified map of raw messages.
func UnmarshalServiceCredentialsResourceKey ¶ added in v2.0.2
func UnmarshalServiceCredentialsResourceKey(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsResourceKey unmarshals an instance of ServiceCredentialsResourceKey from the specified map of raw messages.
func UnmarshalServiceCredentialsSecret ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecret(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecret unmarshals an instance of ServiceCredentialsSecret from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretCredentials ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecretCredentials(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretCredentials unmarshals an instance of ServiceCredentialsSecretCredentials from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretMetadata ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecretMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretMetadata unmarshals an instance of ServiceCredentialsSecretMetadata from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretMetadataPatch ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretMetadataPatch unmarshals an instance of ServiceCredentialsSecretMetadataPatch from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretPrototype ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretPrototype unmarshals an instance of ServiceCredentialsSecretPrototype from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretSourceService ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecretSourceService(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretSourceService unmarshals an instance of ServiceCredentialsSecretSourceService from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretSourceServiceRO ¶ added in v2.0.3
func UnmarshalServiceCredentialsSecretSourceServiceRO(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretSourceServiceRO unmarshals an instance of ServiceCredentialsSecretSourceServiceRO from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretVersion ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecretVersion(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretVersion unmarshals an instance of ServiceCredentialsSecretVersion from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretVersionMetadata ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretVersionMetadata unmarshals an instance of ServiceCredentialsSecretVersionMetadata from the specified map of raw messages.
func UnmarshalServiceCredentialsSecretVersionPrototype ¶ added in v2.0.2
func UnmarshalServiceCredentialsSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSecretVersionPrototype unmarshals an instance of ServiceCredentialsSecretVersionPrototype from the specified map of raw messages.
func UnmarshalServiceCredentialsSourceServiceIam ¶ added in v2.0.2
func UnmarshalServiceCredentialsSourceServiceIam(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSourceServiceIam unmarshals an instance of ServiceCredentialsSourceServiceIam from the specified map of raw messages.
func UnmarshalServiceCredentialsSourceServiceIamApikey ¶ added in v2.0.2
func UnmarshalServiceCredentialsSourceServiceIamApikey(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSourceServiceIamApikey unmarshals an instance of ServiceCredentialsSourceServiceIamApikey from the specified map of raw messages.
func UnmarshalServiceCredentialsSourceServiceIamRole ¶ added in v2.0.2
func UnmarshalServiceCredentialsSourceServiceIamRole(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSourceServiceIamRole unmarshals an instance of ServiceCredentialsSourceServiceIamRole from the specified map of raw messages.
func UnmarshalServiceCredentialsSourceServiceIamServiceid ¶ added in v2.0.2
func UnmarshalServiceCredentialsSourceServiceIamServiceid(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSourceServiceIamServiceid unmarshals an instance of ServiceCredentialsSourceServiceIamServiceid from the specified map of raw messages.
func UnmarshalServiceCredentialsSourceServiceInstance ¶ added in v2.0.2
func UnmarshalServiceCredentialsSourceServiceInstance(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSourceServiceInstance unmarshals an instance of ServiceCredentialsSourceServiceInstance from the specified map of raw messages.
func UnmarshalServiceCredentialsSourceServiceParameters ¶ added in v2.0.2
func UnmarshalServiceCredentialsSourceServiceParameters(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSourceServiceParameters unmarshals an instance of ServiceCredentialsSourceServiceParameters from the specified map of raw messages.
func UnmarshalServiceCredentialsSourceServiceRole ¶ added in v2.0.2
func UnmarshalServiceCredentialsSourceServiceRole(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalServiceCredentialsSourceServiceRole unmarshals an instance of ServiceCredentialsSourceServiceRole from the specified map of raw messages.
func UnmarshalUsernamePasswordSecret ¶
func UnmarshalUsernamePasswordSecret(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalUsernamePasswordSecret unmarshals an instance of UsernamePasswordSecret from the specified map of raw messages.
func UnmarshalUsernamePasswordSecretMetadata ¶
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 UnmarshalUsernamePasswordSecretMetadataPatch ¶
func UnmarshalUsernamePasswordSecretMetadataPatch(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalUsernamePasswordSecretMetadataPatch unmarshals an instance of UsernamePasswordSecretMetadataPatch from the specified map of raw messages.
func UnmarshalUsernamePasswordSecretPrototype ¶
func UnmarshalUsernamePasswordSecretPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalUsernamePasswordSecretPrototype unmarshals an instance of UsernamePasswordSecretPrototype from the specified map of raw messages.
func UnmarshalUsernamePasswordSecretVersion ¶
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 UnmarshalUsernamePasswordSecretVersionMetadata ¶
func UnmarshalUsernamePasswordSecretVersionMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalUsernamePasswordSecretVersionMetadata unmarshals an instance of UsernamePasswordSecretVersionMetadata from the specified map of raw messages.
func UnmarshalUsernamePasswordSecretVersionPrototype ¶
func UnmarshalUsernamePasswordSecretVersionPrototype(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalUsernamePasswordSecretVersionPrototype unmarshals an instance of UsernamePasswordSecretVersionPrototype from the specified map of raw messages.
func UnmarshalVersionAction ¶
func UnmarshalVersionAction(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalVersionAction unmarshals an instance of VersionAction from the specified map of raw messages.
Types ¶
type ArbitrarySecret ¶
type ArbitrarySecret struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The secret data that is assigned to an `arbitrary` secret.
Payload *string `json:"payload,omitempty"`
}
ArbitrarySecret : Your arbitrary secret. This model "extends" Secret
type ArbitrarySecretMetadata ¶
type ArbitrarySecretMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
}
ArbitrarySecretMetadata : Properties of the metadata of your arbitrary secret.. This model "extends" SecretMetadata
type ArbitrarySecretMetadataPatch ¶
type ArbitrarySecretMetadataPatch struct {
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
}
ArbitrarySecretMetadataPatch : ArbitrarySecretMetadataPatch struct This model "extends" SecretMetadataPatch
func (*ArbitrarySecretMetadataPatch) AsPatch ¶
func (arbitrarySecretMetadataPatch *ArbitrarySecretMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the ArbitrarySecretMetadataPatch
type ArbitrarySecretPrototype ¶
type ArbitrarySecretPrototype struct {
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.
Name *string `json:"name" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret data that is assigned to an `arbitrary` secret.
Payload *string `json:"payload" validate:"required"`
// The secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}
ArbitrarySecretPrototype : ArbitrarySecretPrototype struct This model "extends" SecretPrototype
type ArbitrarySecretVersion ¶
type ArbitrarySecretVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The secret data that is assigned to an `arbitrary` secret.
Payload *string `json:"payload,omitempty"`
}
ArbitrarySecretVersion : Your arbitrary secret version. This model "extends" SecretVersion
type ArbitrarySecretVersionMetadata ¶
type ArbitrarySecretVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
}
ArbitrarySecretVersionMetadata : Properties of the version metadata of your arbitrary secret. This model "extends" SecretVersionMetadata
type ArbitrarySecretVersionPrototype ¶
type ArbitrarySecretVersionPrototype struct {
// The secret data that is assigned to an `arbitrary` secret.
Payload *string `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"`
}
ArbitrarySecretVersionPrototype : ArbitrarySecretVersionPrototype struct This model "extends" SecretVersionPrototype
type CertificateIssuanceInfo ¶
type CertificateIssuanceInfo struct {
// This parameter indicates whether the issued certificate is configured with an automatic rotation policy.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.
Challenges []ChallengeResource `json:"challenges,omitempty"`
// The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS
// provider. The date format follows `RFC 3339`.
DnsChallengeValidationTime *strfmt.DateTime `json:"dns_challenge_validation_time,omitempty"`
// A code that identifies an issuance error.
//
// This field, along with `error_message`, is returned when Secrets Manager successfully processes your request, but
// the certificate authority is unable to issue a certificate.
ErrorCode *string `json:"error_code,omitempty"`
// A human-readable message that provides details about the issuance error.
ErrorMessage *string `json:"error_message,omitempty"`
// The date when the certificate is ordered. The date format follows `RFC 3339`.
OrderedOn *strfmt.DateTime `json:"ordered_on,omitempty"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
}
CertificateIssuanceInfo : Issuance information that is associated with your certificate.
type CertificateValidity ¶
type CertificateValidity struct {
// The date-time format follows `RFC 3339`.
NotBefore *strfmt.DateTime `json:"not_before" validate:"required"`
// The date-time format follows `RFC 3339`.
NotAfter *strfmt.DateTime `json:"not_after" validate:"required"`
}
CertificateValidity : The date and time that the certificate validity period begins and ends.
type ChallengeResource ¶
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 CommonRotationPolicy ¶
type CommonRotationPolicy struct {
// This field indicates whether Secrets Manager rotates your secret automatically.
//
// The default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined
// interval.
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"`
}
CommonRotationPolicy : This field indicates whether Secrets Manager rotates your secrets automatically. This model "extends" RotationPolicy
type Configuration ¶
type Configuration struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type,omitempty"`
// The unique name of your configuration.
Name *string `json:"name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by,omitempty"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
// The configuration of the Let's Encrypt CA environment.
LetsEncryptEnvironment *string `json:"lets_encrypt_environment,omitempty"`
// This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
// Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
LetsEncryptPreferredChain *string `json:"lets_encrypt_preferred_chain,omitempty"`
// The PEM-encoded private key of your Let's Encrypt account. The data must be formatted on a single line with embedded
// newline characters.
LetsEncryptPrivateKey *string `json:"lets_encrypt_private_key,omitempty"`
// An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
//
// To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
// key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records you
// need to assign the Manager role.
//
// If you want to manage specific domains, you can assign the Manager role for this specific domain. 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.
//
// If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance with
// service-to-service authorization.
//
// For more information, see the
// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
CloudInternetServicesApikey *string `json:"cloud_internet_services_apikey,omitempty"`
// A CRN that uniquely identifies an IBM Cloud resource.
CloudInternetServicesCrn *string `json:"cloud_internet_services_crn,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"`
// 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 Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// This field 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"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 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 maximum time-to-live (TTL) for certificates that are created by this CA in seconds.
MaxTtlSeconds *int64 `json:"max_ttl_seconds,omitempty"`
// The time until the certificate revocation list (CRL) expires, in seconds.
CrlExpirySeconds *int64 `json:"crl_expiry_seconds,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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"`
// he requested TTL, after which the certificate expires.
TtlSeconds *int64 `json:"ttl_seconds,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 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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The configuration data of your Private Certificate.
Data PrivateCertificateCADataIntf `json:"data,omitempty"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,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 name of the intermediate certificate authority.
CertificateAuthority *string `json:"certificate_authority,omitempty"`
// This field 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates whether to allow clients to request a private certificate that matches any common name.
AllowAnyName *bool `json:"allow_any_name,omitempty"`
// This field indicates whether to enforce only valid hostnames for common names, DNS Subject Alternative Names, and
// the host section of email addresses.
EnforceHostnames *bool `json:"enforce_hostnames,omitempty"`
// This field indicates 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"`
// This field indicates whether private certificates are flagged for server use.
ServerFlag *bool `json:"server_flag,omitempty"`
// This field indicates whether private certificates are flagged for client use.
ClientFlag *bool `json:"client_flag,omitempty"`
// This field indicates whether private certificates are flagged for code signing use.
CodeSigningFlag *bool `json:"code_signing_flag,omitempty"`
// This field indicates 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 `private_cert_configuration_action_sign_csr` action, this field determines whether to use the
// common name (CN) from a certificate signing request (CSR) instead of the CN that is included in the 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 `private_cert_configuration_action_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 data of the
// certificate.
//
// This field 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"`
// This field indicates 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"`
// This field indicates 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.
NotBeforeDurationSeconds *int64 `json:"not_before_duration_seconds,omitempty"`
}
Configuration : Your configuration. Models which "extend" this model: - PublicCertificateConfigurationCALetsEncrypt - PublicCertificateConfigurationDNSCloudInternetServices - PublicCertificateConfigurationDNSClassicInfrastructure - IAMCredentialsConfiguration - PrivateCertificateConfigurationRootCA - PrivateCertificateConfigurationIntermediateCA - PrivateCertificateConfigurationTemplate
type ConfigurationAction ¶
type ConfigurationAction struct {
// The type of configuration action.
ActionType *string `json:"action_type,omitempty"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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, for example '12h'. The value can't
// exceed the `max_ttl` that is defined in the associated certificate template.
TTL *string `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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.
PermittedDnsDomains []string `json:"permitted_dns_domains,omitempty"`
// This field indicates whether to use values from a certificate signing request (CSR) to complete a
// `private_cert_configuration_action_sign_csr` action. If it is set to `true`, then:
//
// 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
// values that are provided in the other parameters to this operation.
//
// 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
// usages used for CA certificates that are signed by the 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,omitempty"`
// The certificate signing request.
Csr *string `json:"csr,omitempty"`
// The data that is associated with the root certificate authority.
Data *PrivateCertificateConfigurationCACertificate `json:"data,omitempty"`
// The name of the intermediate certificate authority configuration.
IntermediateCertificateAuthority *string `json:"intermediate_certificate_authority,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,omitempty"`
// This field indicates whether the request to rotate the CRL for the private certificate configuration was successful.
Success *bool `json:"success,omitempty"`
}
ConfigurationAction : The response body to specify the properties of the action to create a configuration. Models which "extend" this model: - PrivateCertificateConfigurationActionRevoke - PrivateCertificateConfigurationActionSignCSR - PrivateCertificateConfigurationActionSignIntermediate - PrivateCertificateConfigurationActionSetSigned - PrivateCertificateConfigurationActionRotateCRL
type ConfigurationActionIntf ¶
type ConfigurationActionIntf interface {
// contains filtered or unexported methods
}
type ConfigurationActionPrototype ¶
type ConfigurationActionPrototype struct {
// The type of configuration action.
ActionType *string `json:"action_type,omitempty"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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, for example '12h'. The value can't
// exceed the `max_ttl` that is defined in the associated certificate template.
TTL *string `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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.
PermittedDnsDomains []string `json:"permitted_dns_domains,omitempty"`
// This field indicates whether to use values from a certificate signing request (CSR) to complete a
// `private_cert_configuration_action_sign_csr` action. If it is set to `true`, then:
//
// 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
// values that are provided in the other parameters to this operation.
//
// 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
// usages used for CA certificates that are signed by the 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,omitempty"`
// The certificate signing request.
Csr *string `json:"csr,omitempty"`
// The name of the intermediate certificate authority configuration.
IntermediateCertificateAuthority *string `json:"intermediate_certificate_authority,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,omitempty"`
}
ConfigurationActionPrototype : The request body to specify the properties of the action to create a configuration. Models which "extend" this model: - PrivateCertificateConfigurationActionRotateCRLPrototype - PrivateCertificateConfigurationActionRevokePrototype - PrivateCertificateConfigurationActionSignCSRPrototype - PrivateCertificateConfigurationActionSignIntermediatePrototype - PrivateCertificateConfigurationActionSetSignedPrototype
type ConfigurationActionPrototypeIntf ¶
type ConfigurationActionPrototypeIntf interface {
// contains filtered or unexported methods
}
type ConfigurationIntf ¶
type ConfigurationIntf interface {
// contains filtered or unexported methods
}
type ConfigurationMetadata ¶
type ConfigurationMetadata struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type,omitempty"`
// The unique name of your configuration.
Name *string `json:"name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by,omitempty"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
// The configuration of the Let's Encrypt CA environment.
LetsEncryptEnvironment *string `json:"lets_encrypt_environment,omitempty"`
// This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
// Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
LetsEncryptPreferredChain *string `json:"lets_encrypt_preferred_chain,omitempty"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// This field 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"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 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 distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,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 name of the intermediate certificate authority.
CertificateAuthority *string `json:"certificate_authority,omitempty"`
}
ConfigurationMetadata : Your configuration metadata properties. Models which "extend" this model: - IAMCredentialsConfigurationMetadata - PublicCertificateConfigurationCALetsEncryptMetadata - PublicCertificateConfigurationDNSCloudInternetServicesMetadata - PublicCertificateConfigurationDNSClassicInfrastructureMetadata - PrivateCertificateConfigurationRootCAMetadata - PrivateCertificateConfigurationIntermediateCAMetadata - PrivateCertificateConfigurationTemplateMetadata
type ConfigurationMetadataIntf ¶
type ConfigurationMetadataIntf interface {
// contains filtered or unexported methods
}
type ConfigurationMetadataPaginatedCollection ¶
type ConfigurationMetadataPaginatedCollection struct {
// The total number of resources in a collection.
TotalCount *int64 `json:"total_count" validate:"required"`
// The number of items that are retrieved in a collection.
Limit *int64 `json:"limit" validate:"required"`
// The number of items that are skipped in a collection.
Offset *int64 `json:"offset" validate:"required"`
// A URL that points to the first page in a collection.
First *PaginatedCollectionFirst `json:"first" validate:"required"`
// A URL that points to the next page in a collection.
Next *PaginatedCollectionNext `json:"next,omitempty"`
// A URL that points to the previous page in a collection.
Previous *PaginatedCollectionPrevious `json:"previous,omitempty"`
// A URL that points to the last page in a collection.
Last *PaginatedCollectionLast `json:"last" validate:"required"`
// A collection of configuration metadata.
Configurations []ConfigurationMetadataIntf `json:"configurations" validate:"required"`
}
ConfigurationMetadataPaginatedCollection : Properties that describe a paginated collection of secret locks.
func (*ConfigurationMetadataPaginatedCollection) GetNextOffset ¶
func (resp *ConfigurationMetadataPaginatedCollection) GetNextOffset() (*int64, error)
Retrieve the value to be passed to a request to access the next page of results
type ConfigurationPatch ¶
type ConfigurationPatch 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 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 *string `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 *string `json:"crl_expiry,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// This field 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"`
// This field 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 requested time-to-live (TTL) for certificates that are created by this CA. This field's value can't be longer
// than the `max_ttl` limit.
//
// 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).
TTL *string `json:"ttl,omitempty"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates whether to allow clients to request a private certificate that matches any common name.
AllowAnyName *bool `json:"allow_any_name,omitempty"`
// This field indicates whether to enforce only valid hostnames for common names, DNS Subject Alternative Names, and
// the host section of email addresses.
EnforceHostnames *bool `json:"enforce_hostnames,omitempty"`
// This field indicates 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"`
// This field indicates whether private certificates are flagged for server use.
ServerFlag *bool `json:"server_flag,omitempty"`
// This field indicates whether private certificates are flagged for client use.
ClientFlag *bool `json:"client_flag,omitempty"`
// This field indicates whether private certificates are flagged for code signing use.
CodeSigningFlag *bool `json:"code_signing_flag,omitempty"`
// This field indicates whether private certificates are flagged for email protection use.
EmailProtectionFlag *bool `json:"email_protection_flag,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 `private_cert_configuration_action_sign_csr` action, this field determines whether to use the
// common name (CN) from a certificate signing request (CSR) instead of the CN that is included in the 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 `private_cert_configuration_action_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 data of the
// certificate.
//
// This field 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// This field is deprecated. You can ignore its value.
SerialNumber *string `json:"serial_number,omitempty"`
// This field indicates 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"`
// This field indicates 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 *string `json:"not_before_duration,omitempty"`
// The configuration of the Let's Encrypt CA environment.
LetsEncryptEnvironment *string `json:"lets_encrypt_environment,omitempty"`
// The PEM-encoded private key of your Let's Encrypt account. The data must be formatted on a single line with embedded
// newline characters.
LetsEncryptPrivateKey *string `json:"lets_encrypt_private_key,omitempty"`
// This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
// Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
LetsEncryptPreferredChain *string `json:"lets_encrypt_preferred_chain,omitempty"`
// An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
//
// To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
// key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records you
// need to assign the Manager role.
//
// If you want to manage specific domains, you can assign the Manager role for this specific domain. 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.
//
// If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance with
// service-to-service authorization.
//
// For more information, see the
// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
CloudInternetServicesApikey *string `json:"cloud_internet_services_apikey,omitempty"`
// A CRN that uniquely identifies an IBM Cloud resource.
CloudInternetServicesCrn *string `json:"cloud_internet_services_crn,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"`
}
ConfigurationPatch : Your configuration update data. Models which "extend" this model: - IAMCredentialsConfigurationPatch - PrivateCertificateConfigurationRootCAPatch - PrivateCertificateConfigurationIntermediateCAPatch - PrivateCertificateConfigurationTemplatePatch - PublicCertificateConfigurationCALetsEncryptPatch - PublicCertificateConfigurationDNSCloudInternetServicesPatch - PublicCertificateConfigurationDNSClassicInfrastructurePatch
func (*ConfigurationPatch) AsPatch ¶
func (configurationPatch *ConfigurationPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the ConfigurationPatch
type ConfigurationPatchIntf ¶
type ConfigurationPatchIntf interface {
// contains filtered or unexported methods
}
type ConfigurationPrototype ¶
type ConfigurationPrototype struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type,omitempty"`
// A human-readable unique name to assign to your configuration.
//
// To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
Name *string `json:"name,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 *string `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 *string `json:"crl_expiry,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// This field 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 Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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 requested time-to-live (TTL) for certificates that are created by this CA. This field's value can't be longer
// than the `max_ttl` limit.
//
// 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).
TTL *string `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 to generate 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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,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 distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,omitempty"`
// The name of the intermediate certificate authority.
CertificateAuthority *string `json:"certificate_authority,omitempty"`
// This field 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates whether the issuance of certificates with RFC 6125 wildcards in the CN field.
//
// When set to false, this field prevents wildcards from being issued even if they can be allowed by an option
// `allow_glob_domains`.
AllowWildcardCertificates *bool `json:"allow_wildcard_certificates,omitempty"`
// This field indicates whether to allow clients to request a private certificate that matches any common name.
AllowAnyName *bool `json:"allow_any_name,omitempty"`
// This field indicates whether to enforce only valid hostnames for common names, DNS Subject Alternative Names, and
// the host section of email addresses.
EnforceHostnames *bool `json:"enforce_hostnames,omitempty"`
// This field indicates 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"`
// This field indicates whether private certificates are flagged for server use.
ServerFlag *bool `json:"server_flag,omitempty"`
// This field indicates whether private certificates are flagged for client use.
ClientFlag *bool `json:"client_flag,omitempty"`
// This field indicates whether private certificates are flagged for code signing use.
CodeSigningFlag *bool `json:"code_signing_flag,omitempty"`
// This field indicates 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 `private_cert_configuration_action_sign_csr` action, this field determines whether to use the
// common name (CN) from a certificate signing request (CSR) instead of the CN that is included in the 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 `private_cert_configuration_action_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 data of the
// certificate.
//
// This field 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"`
// This field indicates 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"`
// This field indicates 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 *string `json:"not_before_duration,omitempty"`
// The configuration of the Let's Encrypt CA environment.
LetsEncryptEnvironment *string `json:"lets_encrypt_environment,omitempty"`
// The PEM-encoded private key of your Let's Encrypt account. The data must be formatted on a single line with embedded
// newline characters.
LetsEncryptPrivateKey *string `json:"lets_encrypt_private_key,omitempty"`
// This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
// Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
LetsEncryptPreferredChain *string `json:"lets_encrypt_preferred_chain,omitempty"`
// An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
//
// To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
// key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records you
// need to assign the Manager role.
//
// If you want to manage specific domains, you can assign the Manager role for this specific domain. 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.
//
// If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance with
// service-to-service authorization.
//
// For more information, see the
// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
CloudInternetServicesApikey *string `json:"cloud_internet_services_apikey,omitempty"`
// A CRN that uniquely identifies an IBM Cloud resource.
CloudInternetServicesCrn *string `json:"cloud_internet_services_crn,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 API key that is used to set the iam_credentials engine.
ApiKey *string `json:"api_key,omitempty"`
}
ConfigurationPrototype : The details of your configuration. Models which "extend" this model: - PrivateCertificateConfigurationRootCAPrototype - PrivateCertificateConfigurationIntermediateCAPrototype - PrivateCertificateConfigurationTemplatePrototype - PublicCertificateConfigurationCALetsEncryptPrototype - PublicCertificateConfigurationDNSCloudInternetServicesPrototype - PublicCertificateConfigurationDNSClassicInfrastructurePrototype - IAMCredentialsConfigurationPrototype
type ConfigurationPrototypeIntf ¶
type ConfigurationPrototypeIntf interface {
// contains filtered or unexported methods
}
type ConfigurationsPager ¶
type ConfigurationsPager struct {
// contains filtered or unexported fields
}
ConfigurationsPager can be used to simplify the use of the "ListConfigurations" method.
func (*ConfigurationsPager) GetAll ¶
func (pager *ConfigurationsPager) GetAll() (allItems []ConfigurationMetadataIntf, err error)
GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.
func (*ConfigurationsPager) GetAllWithContext ¶
func (pager *ConfigurationsPager) GetAllWithContext(ctx context.Context) (allItems []ConfigurationMetadataIntf, err error)
GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.
func (*ConfigurationsPager) GetNext ¶
func (pager *ConfigurationsPager) GetNext() (page []ConfigurationMetadataIntf, err error)
GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.
func (*ConfigurationsPager) GetNextWithContext ¶
func (pager *ConfigurationsPager) GetNextWithContext(ctx context.Context) (page []ConfigurationMetadataIntf, err error)
GetNextWithContext returns the next page of results using the specified Context.
func (*ConfigurationsPager) HasNext ¶
func (pager *ConfigurationsPager) HasNext() bool
HasNext returns true if there are potentially more results to be retrieved.
type CreateConfigurationActionOptions ¶
type CreateConfigurationActionOptions struct {
// The name that uniquely identifies a configuration.
Name *string `json:"name" validate:"required,ne="`
// The request body to specify the properties of the action to create a configuration.
ConfigActionPrototype ConfigurationActionPrototypeIntf `json:"ConfigActionPrototype" validate:"required"`
// The configuration type of this configuration - use this header to resolve 300 error responses.
XSmAcceptConfigurationType *string `json:"X-Sm-Accept-Configuration-Type,omitempty"`
// Allows users to set headers on API requests
Headers map[string]string
}
CreateConfigurationActionOptions : The CreateConfigurationAction options.
func (*CreateConfigurationActionOptions) SetConfigActionPrototype ¶
func (_options *CreateConfigurationActionOptions) SetConfigActionPrototype(configActionPrototype ConfigurationActionPrototypeIntf) *CreateConfigurationActionOptions
SetConfigActionPrototype : Allow user to set ConfigActionPrototype
func (*CreateConfigurationActionOptions) SetHeaders ¶
func (options *CreateConfigurationActionOptions) SetHeaders(param map[string]string) *CreateConfigurationActionOptions
SetHeaders : Allow user to set Headers
func (*CreateConfigurationActionOptions) SetName ¶
func (_options *CreateConfigurationActionOptions) SetName(name string) *CreateConfigurationActionOptions
SetName : Allow user to set Name
func (*CreateConfigurationActionOptions) SetXSmAcceptConfigurationType ¶
func (_options *CreateConfigurationActionOptions) SetXSmAcceptConfigurationType(xSmAcceptConfigurationType string) *CreateConfigurationActionOptions
SetXSmAcceptConfigurationType : Allow user to set XSmAcceptConfigurationType
type CreateConfigurationOptions ¶
type CreateConfigurationOptions struct {
// The details of your configuration.
ConfigurationPrototype ConfigurationPrototypeIntf `json:"ConfigurationPrototype" validate:"required"`
// Allows users to set headers on API requests
Headers map[string]string
}
CreateConfigurationOptions : The CreateConfiguration options.
func (*CreateConfigurationOptions) SetConfigurationPrototype ¶
func (_options *CreateConfigurationOptions) SetConfigurationPrototype(configurationPrototype ConfigurationPrototypeIntf) *CreateConfigurationOptions
SetConfigurationPrototype : Allow user to set ConfigurationPrototype
func (*CreateConfigurationOptions) SetHeaders ¶
func (options *CreateConfigurationOptions) SetHeaders(param map[string]string) *CreateConfigurationOptions
SetHeaders : Allow user to set Headers
type CreateNotificationsRegistrationOptions ¶
type CreateNotificationsRegistrationOptions struct {
// A CRN that uniquely identifies an IBM Cloud resource.
EventNotificationsInstanceCrn *string `json:"event_notifications_instance_crn" validate:"required"`
// The name that is displayed as a source that is in your Event Notifications instance.
EventNotificationsSourceName *string `json:"event_notifications_source_name" validate:"required"`
// An optional description for the source that is 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 ¶
func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsInstanceCrn(eventNotificationsInstanceCrn string) *CreateNotificationsRegistrationOptions
SetEventNotificationsInstanceCrn : Allow user to set EventNotificationsInstanceCrn
func (*CreateNotificationsRegistrationOptions) SetEventNotificationsSourceDescription ¶
func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsSourceDescription(eventNotificationsSourceDescription string) *CreateNotificationsRegistrationOptions
SetEventNotificationsSourceDescription : Allow user to set EventNotificationsSourceDescription
func (*CreateNotificationsRegistrationOptions) SetEventNotificationsSourceName ¶
func (_options *CreateNotificationsRegistrationOptions) SetEventNotificationsSourceName(eventNotificationsSourceName string) *CreateNotificationsRegistrationOptions
SetEventNotificationsSourceName : Allow user to set EventNotificationsSourceName
func (*CreateNotificationsRegistrationOptions) SetHeaders ¶
func (options *CreateNotificationsRegistrationOptions) SetHeaders(param map[string]string) *CreateNotificationsRegistrationOptions
SetHeaders : Allow user to set Headers
type CreateSecretActionOptions ¶
type CreateSecretActionOptions struct {
// The v4 UUID that uniquely identifies your secret.
ID *string `json:"id" validate:"required,ne="`
// The request body to specify the properties for your secret action.
SecretActionPrototype SecretActionPrototypeIntf `json:"SecretActionPrototype" validate:"required"`
// Allows users to set headers on API requests
Headers map[string]string
}
CreateSecretActionOptions : The CreateSecretAction options.
func (*CreateSecretActionOptions) SetHeaders ¶
func (options *CreateSecretActionOptions) SetHeaders(param map[string]string) *CreateSecretActionOptions
SetHeaders : Allow user to set Headers
func (*CreateSecretActionOptions) SetID ¶
func (_options *CreateSecretActionOptions) SetID(id string) *CreateSecretActionOptions
SetID : Allow user to set ID
func (*CreateSecretActionOptions) SetSecretActionPrototype ¶
func (_options *CreateSecretActionOptions) SetSecretActionPrototype(secretActionPrototype SecretActionPrototypeIntf) *CreateSecretActionOptions
SetSecretActionPrototype : Allow user to set SecretActionPrototype
type CreateSecretGroupOptions ¶
type CreateSecretGroupOptions struct {
// The name of your secret group.
Name *string `json:"name" validate:"required"`
// 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"`
// Allows users to set headers on API requests
Headers map[string]string
}
CreateSecretGroupOptions : The CreateSecretGroup options.
func (*CreateSecretGroupOptions) SetDescription ¶
func (_options *CreateSecretGroupOptions) SetDescription(description string) *CreateSecretGroupOptions
SetDescription : Allow user to set Description
func (*CreateSecretGroupOptions) SetHeaders ¶
func (options *CreateSecretGroupOptions) SetHeaders(param map[string]string) *CreateSecretGroupOptions
SetHeaders : Allow user to set Headers
func (*CreateSecretGroupOptions) SetName ¶
func (_options *CreateSecretGroupOptions) SetName(name string) *CreateSecretGroupOptions
SetName : Allow user to set Name
type CreateSecretLocksBulkOptions ¶
type CreateSecretLocksBulkOptions struct {
// The v4 UUID that uniquely identifies your secret.
ID *string `json:"id" validate:"required,ne="`
// The locks data to be attached to a secret version.
Locks []SecretLockPrototype `json:"locks" validate:"required"`
// An optional lock mode. When you create a lock, you can set one of the following modes to clear any matching locks on
// a secret version.
// - `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the
// secret. - `remove_previous_and_delete`: Completes the same action as `remove_previous`, 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
}
CreateSecretLocksBulkOptions : The CreateSecretLocksBulk options.
func (*CreateSecretLocksBulkOptions) SetHeaders ¶
func (options *CreateSecretLocksBulkOptions) SetHeaders(param map[string]string) *CreateSecretLocksBulkOptions
SetHeaders : Allow user to set Headers
func (*CreateSecretLocksBulkOptions) SetID ¶
func (_options *CreateSecretLocksBulkOptions) SetID(id string) *CreateSecretLocksBulkOptions
SetID : Allow user to set ID
func (*CreateSecretLocksBulkOptions) SetLocks ¶
func (_options *CreateSecretLocksBulkOptions) SetLocks(locks []SecretLockPrototype) *CreateSecretLocksBulkOptions
SetLocks : Allow user to set Locks
func (*CreateSecretLocksBulkOptions) SetMode ¶
func (_options *CreateSecretLocksBulkOptions) SetMode(mode string) *CreateSecretLocksBulkOptions
SetMode : Allow user to set Mode
type CreateSecretOptions ¶
type CreateSecretOptions struct {
// Specify the properties for your secret.
SecretPrototype SecretPrototypeIntf `json:"SecretPrototype" 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) SetSecretPrototype ¶
func (_options *CreateSecretOptions) SetSecretPrototype(secretPrototype SecretPrototypeIntf) *CreateSecretOptions
SetSecretPrototype : Allow user to set SecretPrototype
type CreateSecretVersionActionOptions ¶
type CreateSecretVersionActionOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// The v4 UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer
// to the current or previous secret version.
ID *string `json:"id" validate:"required,ne="`
// The request body to specify the properties of the action to create a secret version.
SecretVersionActionPrototype SecretVersionActionPrototypeIntf `json:"SecretVersionActionPrototype" validate:"required"`
// Allows users to set headers on API requests
Headers map[string]string
}
CreateSecretVersionActionOptions : The CreateSecretVersionAction options.
func (*CreateSecretVersionActionOptions) SetHeaders ¶
func (options *CreateSecretVersionActionOptions) SetHeaders(param map[string]string) *CreateSecretVersionActionOptions
SetHeaders : Allow user to set Headers
func (*CreateSecretVersionActionOptions) SetID ¶
func (_options *CreateSecretVersionActionOptions) SetID(id string) *CreateSecretVersionActionOptions
SetID : Allow user to set ID
func (*CreateSecretVersionActionOptions) SetSecretID ¶
func (_options *CreateSecretVersionActionOptions) SetSecretID(secretID string) *CreateSecretVersionActionOptions
SetSecretID : Allow user to set SecretID
func (*CreateSecretVersionActionOptions) SetSecretVersionActionPrototype ¶
func (_options *CreateSecretVersionActionOptions) SetSecretVersionActionPrototype(secretVersionActionPrototype SecretVersionActionPrototypeIntf) *CreateSecretVersionActionOptions
SetSecretVersionActionPrototype : Allow user to set SecretVersionActionPrototype
type CreateSecretVersionLocksBulkOptions ¶
type CreateSecretVersionLocksBulkOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// The v4 UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer
// to the current or previous secret version.
ID *string `json:"id" validate:"required,ne="`
// The locks data to be attached to a secret version.
Locks []SecretLockPrototype `json:"locks" validate:"required"`
// An optional lock mode. When you create a lock, you can set one of the following modes to clear any matching locks on
// a secret version.
// - `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the
// secret. - `remove_previous_and_delete`: Completes the same action as `remove_previous`, 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
}
CreateSecretVersionLocksBulkOptions : The CreateSecretVersionLocksBulk options.
func (*CreateSecretVersionLocksBulkOptions) SetHeaders ¶
func (options *CreateSecretVersionLocksBulkOptions) SetHeaders(param map[string]string) *CreateSecretVersionLocksBulkOptions
SetHeaders : Allow user to set Headers
func (*CreateSecretVersionLocksBulkOptions) SetID ¶
func (_options *CreateSecretVersionLocksBulkOptions) SetID(id string) *CreateSecretVersionLocksBulkOptions
SetID : Allow user to set ID
func (*CreateSecretVersionLocksBulkOptions) SetLocks ¶
func (_options *CreateSecretVersionLocksBulkOptions) SetLocks(locks []SecretLockPrototype) *CreateSecretVersionLocksBulkOptions
SetLocks : Allow user to set Locks
func (*CreateSecretVersionLocksBulkOptions) SetMode ¶
func (_options *CreateSecretVersionLocksBulkOptions) SetMode(mode string) *CreateSecretVersionLocksBulkOptions
SetMode : Allow user to set Mode
func (*CreateSecretVersionLocksBulkOptions) SetSecretID ¶
func (_options *CreateSecretVersionLocksBulkOptions) SetSecretID(secretID string) *CreateSecretVersionLocksBulkOptions
SetSecretID : Allow user to set SecretID
type CreateSecretVersionOptions ¶
type CreateSecretVersionOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// Specify the properties for your new secret version.
SecretVersionPrototype SecretVersionPrototypeIntf `json:"SecretVersionPrototype" validate:"required"`
// Allows users to set headers on API requests
Headers map[string]string
}
CreateSecretVersionOptions : The CreateSecretVersion options.
func (*CreateSecretVersionOptions) SetHeaders ¶
func (options *CreateSecretVersionOptions) SetHeaders(param map[string]string) *CreateSecretVersionOptions
SetHeaders : Allow user to set Headers
func (*CreateSecretVersionOptions) SetSecretID ¶
func (_options *CreateSecretVersionOptions) SetSecretID(secretID string) *CreateSecretVersionOptions
SetSecretID : Allow user to set SecretID
func (*CreateSecretVersionOptions) SetSecretVersionPrototype ¶
func (_options *CreateSecretVersionOptions) SetSecretVersionPrototype(secretVersionPrototype SecretVersionPrototypeIntf) *CreateSecretVersionOptions
SetSecretVersionPrototype : Allow user to set SecretVersionPrototype
type DeleteConfigurationOptions ¶
type DeleteConfigurationOptions struct {
// The name that uniquely identifies a configuration.
Name *string `json:"name" validate:"required,ne="`
// The configuration type of this configuration - use this header to resolve 300 error responses.
XSmAcceptConfigurationType *string `json:"X-Sm-Accept-Configuration-Type,omitempty"`
// Allows users to set headers on API requests
Headers map[string]string
}
DeleteConfigurationOptions : The DeleteConfiguration options.
func (*DeleteConfigurationOptions) SetHeaders ¶
func (options *DeleteConfigurationOptions) SetHeaders(param map[string]string) *DeleteConfigurationOptions
SetHeaders : Allow user to set Headers
func (*DeleteConfigurationOptions) SetName ¶
func (_options *DeleteConfigurationOptions) SetName(name string) *DeleteConfigurationOptions
SetName : Allow user to set Name
func (*DeleteConfigurationOptions) SetXSmAcceptConfigurationType ¶
func (_options *DeleteConfigurationOptions) SetXSmAcceptConfigurationType(xSmAcceptConfigurationType string) *DeleteConfigurationOptions
SetXSmAcceptConfigurationType : Allow user to set XSmAcceptConfigurationType
type DeleteNotificationsRegistrationOptions ¶
type DeleteNotificationsRegistrationOptions struct {
// Allows users to set headers on API requests
Headers map[string]string
}
DeleteNotificationsRegistrationOptions : The DeleteNotificationsRegistration options.
func (*DeleteNotificationsRegistrationOptions) SetHeaders ¶
func (options *DeleteNotificationsRegistrationOptions) SetHeaders(param map[string]string) *DeleteNotificationsRegistrationOptions
SetHeaders : Allow user to set Headers
type DeleteSecretGroupOptions ¶
type DeleteSecretGroupOptions struct {
// The v4 UUID that uniquely identifies your 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 ¶
func (_options *DeleteSecretGroupOptions) SetID(id string) *DeleteSecretGroupOptions
SetID : Allow user to set ID
type DeleteSecretLocksBulkOptions ¶
type DeleteSecretLocksBulkOptions struct {
// The v4 UUID that uniquely identifies your secret.
ID *string `json:"id" validate:"required,ne="`
// Specify the names of the secret locks to be deleted.
Name []string `json:"name,omitempty"`
// Allows users to set headers on API requests
Headers map[string]string
}
DeleteSecretLocksBulkOptions : The DeleteSecretLocksBulk options.
func (*DeleteSecretLocksBulkOptions) SetHeaders ¶
func (options *DeleteSecretLocksBulkOptions) SetHeaders(param map[string]string) *DeleteSecretLocksBulkOptions
SetHeaders : Allow user to set Headers
func (*DeleteSecretLocksBulkOptions) SetID ¶
func (_options *DeleteSecretLocksBulkOptions) SetID(id string) *DeleteSecretLocksBulkOptions
SetID : Allow user to set ID
func (*DeleteSecretLocksBulkOptions) SetName ¶
func (_options *DeleteSecretLocksBulkOptions) SetName(name []string) *DeleteSecretLocksBulkOptions
SetName : Allow user to set Name
type DeleteSecretOptions ¶
type DeleteSecretOptions struct {
// The v4 UUID that uniquely identifies your 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
type DeleteSecretVersionDataOptions ¶
type DeleteSecretVersionDataOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// The v4 UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer
// to the current or previous secret version.
ID *string `json:"id" validate:"required,ne="`
// Allows users to set headers on API requests
Headers map[string]string
}
DeleteSecretVersionDataOptions : The DeleteSecretVersionData options.
func (*DeleteSecretVersionDataOptions) SetHeaders ¶
func (options *DeleteSecretVersionDataOptions) SetHeaders(param map[string]string) *DeleteSecretVersionDataOptions
SetHeaders : Allow user to set Headers
func (*DeleteSecretVersionDataOptions) SetID ¶
func (_options *DeleteSecretVersionDataOptions) SetID(id string) *DeleteSecretVersionDataOptions
SetID : Allow user to set ID
func (*DeleteSecretVersionDataOptions) SetSecretID ¶
func (_options *DeleteSecretVersionDataOptions) SetSecretID(secretID string) *DeleteSecretVersionDataOptions
SetSecretID : Allow user to set SecretID
type DeleteSecretVersionLocksBulkOptions ¶
type DeleteSecretVersionLocksBulkOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// The v4 UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer
// to the current or previous secret version.
ID *string `json:"id" validate:"required,ne="`
// Specify the names of the secret locks to be deleted.
Name []string `json:"name,omitempty"`
// Allows users to set headers on API requests
Headers map[string]string
}
DeleteSecretVersionLocksBulkOptions : The DeleteSecretVersionLocksBulk options.
func (*DeleteSecretVersionLocksBulkOptions) SetHeaders ¶
func (options *DeleteSecretVersionLocksBulkOptions) SetHeaders(param map[string]string) *DeleteSecretVersionLocksBulkOptions
SetHeaders : Allow user to set Headers
func (*DeleteSecretVersionLocksBulkOptions) SetID ¶
func (_options *DeleteSecretVersionLocksBulkOptions) SetID(id string) *DeleteSecretVersionLocksBulkOptions
SetID : Allow user to set ID
func (*DeleteSecretVersionLocksBulkOptions) SetName ¶
func (_options *DeleteSecretVersionLocksBulkOptions) SetName(name []string) *DeleteSecretVersionLocksBulkOptions
SetName : Allow user to set Name
func (*DeleteSecretVersionLocksBulkOptions) SetSecretID ¶
func (_options *DeleteSecretVersionLocksBulkOptions) SetSecretID(secretID string) *DeleteSecretVersionLocksBulkOptions
SetSecretID : Allow user to set SecretID
type GetConfigurationOptions ¶
type GetConfigurationOptions struct {
// The name that uniquely identifies a configuration.
Name *string `json:"name" validate:"required,ne="`
// The configuration type of this configuration - use this header to resolve 300 error responses.
XSmAcceptConfigurationType *string `json:"X-Sm-Accept-Configuration-Type,omitempty"`
// Allows users to set headers on API requests
Headers map[string]string
}
GetConfigurationOptions : The GetConfiguration options.
func (*GetConfigurationOptions) SetHeaders ¶
func (options *GetConfigurationOptions) SetHeaders(param map[string]string) *GetConfigurationOptions
SetHeaders : Allow user to set Headers
func (*GetConfigurationOptions) SetName ¶
func (_options *GetConfigurationOptions) SetName(name string) *GetConfigurationOptions
SetName : Allow user to set Name
func (*GetConfigurationOptions) SetXSmAcceptConfigurationType ¶
func (_options *GetConfigurationOptions) SetXSmAcceptConfigurationType(xSmAcceptConfigurationType string) *GetConfigurationOptions
SetXSmAcceptConfigurationType : Allow user to set XSmAcceptConfigurationType
type GetNotificationsRegistrationOptions ¶
type GetNotificationsRegistrationOptions struct {
// Allows users to set headers on API requests
Headers map[string]string
}
GetNotificationsRegistrationOptions : The GetNotificationsRegistration options.
func (*GetNotificationsRegistrationOptions) SetHeaders ¶
func (options *GetNotificationsRegistrationOptions) SetHeaders(param map[string]string) *GetNotificationsRegistrationOptions
SetHeaders : Allow user to set Headers
type GetNotificationsRegistrationTestOptions ¶
type GetNotificationsRegistrationTestOptions struct {
// Allows users to set headers on API requests
Headers map[string]string
}
GetNotificationsRegistrationTestOptions : The GetNotificationsRegistrationTest options.
func (*GetNotificationsRegistrationTestOptions) SetHeaders ¶
func (options *GetNotificationsRegistrationTestOptions) SetHeaders(param map[string]string) *GetNotificationsRegistrationTestOptions
SetHeaders : Allow user to set Headers
type GetSecretByNameTypeOptions ¶ added in v2.0.1
type GetSecretByNameTypeOptions struct {
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required,ne="`
// A human-readable name to assign to your secret. To protect your privacy, do not use personal data, such as your name
// or location, as a name for your secret.
Name *string `json:"name" validate:"required,ne="`
// The name of your secret group.
SecretGroupName *string `json:"secret_group_name" validate:"required,ne="`
// Allows users to set headers on API requests
Headers map[string]string
}
GetSecretByNameTypeOptions : The GetSecretByNameType options.
func (*GetSecretByNameTypeOptions) SetHeaders ¶ added in v2.0.1
func (options *GetSecretByNameTypeOptions) SetHeaders(param map[string]string) *GetSecretByNameTypeOptions
SetHeaders : Allow user to set Headers
func (*GetSecretByNameTypeOptions) SetName ¶ added in v2.0.1
func (_options *GetSecretByNameTypeOptions) SetName(name string) *GetSecretByNameTypeOptions
SetName : Allow user to set Name
func (*GetSecretByNameTypeOptions) SetSecretGroupName ¶ added in v2.0.1
func (_options *GetSecretByNameTypeOptions) SetSecretGroupName(secretGroupName string) *GetSecretByNameTypeOptions
SetSecretGroupName : Allow user to set SecretGroupName
func (*GetSecretByNameTypeOptions) SetSecretType ¶ added in v2.0.1
func (_options *GetSecretByNameTypeOptions) SetSecretType(secretType string) *GetSecretByNameTypeOptions
SetSecretType : Allow user to set SecretType
type GetSecretGroupOptions ¶
type GetSecretGroupOptions struct {
// The v4 UUID that uniquely identifies your 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 GetSecretMetadataOptions ¶
type GetSecretMetadataOptions struct {
// The v4 UUID that uniquely identifies your 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 ¶
func (_options *GetSecretMetadataOptions) SetID(id string) *GetSecretMetadataOptions
SetID : Allow user to set ID
type GetSecretOptions ¶
type GetSecretOptions struct {
// The v4 UUID that uniquely identifies your 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
type GetSecretVersionMetadataOptions ¶
type GetSecretVersionMetadataOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// The v4 UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer
// to the current or previous secret version.
ID *string `json:"id" validate:"required,ne="`
// Allows users to set headers on API requests
Headers map[string]string
}
GetSecretVersionMetadataOptions : The GetSecretVersionMetadata options.
func (*GetSecretVersionMetadataOptions) SetHeaders ¶
func (options *GetSecretVersionMetadataOptions) SetHeaders(param map[string]string) *GetSecretVersionMetadataOptions
SetHeaders : Allow user to set Headers
func (*GetSecretVersionMetadataOptions) SetID ¶
func (_options *GetSecretVersionMetadataOptions) SetID(id string) *GetSecretVersionMetadataOptions
SetID : Allow user to set ID
func (*GetSecretVersionMetadataOptions) SetSecretID ¶
func (_options *GetSecretVersionMetadataOptions) SetSecretID(secretID string) *GetSecretVersionMetadataOptions
SetSecretID : Allow user to set SecretID
type GetSecretVersionOptions ¶
type GetSecretVersionOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// The v4 UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer
// to the current or previous secret version.
ID *string `json:"id" validate:"required,ne="`
// Allows users to set headers on API requests
Headers map[string]string
}
GetSecretVersionOptions : The GetSecretVersion options.
func (*GetSecretVersionOptions) SetHeaders ¶
func (options *GetSecretVersionOptions) SetHeaders(param map[string]string) *GetSecretVersionOptions
SetHeaders : Allow user to set Headers
func (*GetSecretVersionOptions) SetID ¶
func (_options *GetSecretVersionOptions) SetID(id string) *GetSecretVersionOptions
SetID : Allow user to set ID
func (*GetSecretVersionOptions) SetSecretID ¶
func (_options *GetSecretVersionOptions) SetSecretID(secretID string) *GetSecretVersionOptions
SetSecretID : Allow user to set SecretID
type IAMCredentialsConfiguration ¶
type IAMCredentialsConfiguration struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// 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"`
}
IAMCredentialsConfiguration : Properties that describe a Classic Infrastructure DNS configuration. This model "extends" Configuration
type IAMCredentialsConfigurationMetadata ¶
type IAMCredentialsConfigurationMetadata struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}
IAMCredentialsConfigurationMetadata : Your IAMCredentials Configuration metadata properties. This model "extends" ConfigurationMetadata
type IAMCredentialsConfigurationPatch ¶
type IAMCredentialsConfigurationPatch 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"`
}
IAMCredentialsConfigurationPatch : The configuration update of the IAM Credentials engine. This model "extends" ConfigurationPatch
func (*IAMCredentialsConfigurationPatch) AsPatch ¶
func (iAMCredentialsConfigurationPatch *IAMCredentialsConfigurationPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the IAMCredentialsConfigurationPatch
type IAMCredentialsConfigurationPrototype ¶
type IAMCredentialsConfigurationPrototype struct {
// A human-readable unique name to assign to your configuration.
//
// To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
Name *string `json:"name" validate:"required"`
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The API key that is used to set the iam_credentials engine.
ApiKey *string `json:"api_key" validate:"required"`
}
IAMCredentialsConfigurationPrototype : IAMCredentialsConfigurationPrototype struct This model "extends" ConfigurationPrototype
type IAMCredentialsSecret ¶
type IAMCredentialsSecret struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl" validate:"required"`
// Access Groups that you can use for an `iam_credentials` secret.
//
// Up to 10 Access Groups can be used for each secret.
AccessGroups []string `json:"access_groups,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 it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to
// `false`, the service ID was generated by Secrets Manager.
ServiceIdIsStatic *bool `json:"service_id_is_static,omitempty"`
// (IAM credentials) This parameter indicates whether to reuse the service ID and API key for future read operations.
//
// If it is set to `true`, the service reuses the current credentials. If it is 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" validate:"required"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The API key that is generated for this secret.
//
// After the secret reaches the end of its lease, the API key is deleted automatically. See the `time-to-live` field to
// understand the duration of the lease. 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"`
}
IAMCredentialsSecret : Your IAM credentials secret. This model "extends" Secret
type IAMCredentialsSecretMetadata ¶
type IAMCredentialsSecretMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl" validate:"required"`
// Access Groups that you can use for an `iam_credentials` secret.
//
// Up to 10 Access Groups can be used for each secret.
AccessGroups []string `json:"access_groups,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 it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to
// `false`, the service ID was generated by Secrets Manager.
ServiceIdIsStatic *bool `json:"service_id_is_static,omitempty"`
// (IAM credentials) This parameter indicates whether to reuse the service ID and API key for future read operations.
//
// If it is set to `true`, the service reuses the current credentials. If it is 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" validate:"required"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
}
IAMCredentialsSecretMetadata : Properties of the metadata of your IAM credentials secret. This model "extends" SecretMetadata
type IAMCredentialsSecretMetadataPatch ¶
type IAMCredentialsSecretMetadataPatch struct {
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
}
IAMCredentialsSecretMetadataPatch : IAMCredentialsSecretMetadataPatch struct This model "extends" SecretMetadataPatch
func (*IAMCredentialsSecretMetadataPatch) AsPatch ¶
func (iAMCredentialsSecretMetadataPatch *IAMCredentialsSecretMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the IAMCredentialsSecretMetadataPatch
type IAMCredentialsSecretPrototype ¶
type IAMCredentialsSecretPrototype struct {
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl" validate:"required"`
// Access Groups that you can use for an `iam_credentials` secret.
//
// Up to 10 Access Groups can be used for each secret.
AccessGroups []string `json:"access_groups,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"`
// (IAM credentials) This parameter indicates whether to reuse the service ID and API key for future read operations.
//
// If it is set to `true`, the service reuses the current credentials. If it is 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" validate:"required"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,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"`
}
IAMCredentialsSecretPrototype : IAMCredentialsSecretPrototype struct This model "extends" SecretPrototype
type IAMCredentialsSecretRestoreFromVersionPrototype ¶
type IAMCredentialsSecretRestoreFromVersionPrototype struct {
// A v4 UUID identifier, or `current` or `previous` secret version aliases.
RestoreFromVersion *string `json:"restore_from_version" 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"`
}
IAMCredentialsSecretRestoreFromVersionPrototype : IAMCredentialsSecretRestoreFromVersionPrototype struct This model "extends" SecretVersionPrototype
type IAMCredentialsSecretVersion ¶
type IAMCredentialsSecretVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// 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"`
// The API key that is generated for this secret.
//
// After the secret reaches the end of its lease, the API key is deleted automatically. See the `time-to-live` field to
// understand the duration of the lease. 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"`
}
IAMCredentialsSecretVersion : Your IAM credentials version. This model "extends" SecretVersion
type IAMCredentialsSecretVersionMetadata ¶
type IAMCredentialsSecretVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// 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"`
}
IAMCredentialsSecretVersionMetadata : Properties of the version metadata of your IAM credentials secret. This model "extends" SecretVersionMetadata
type IAMCredentialsSecretVersionPrototype ¶
type IAMCredentialsSecretVersionPrototype struct {
// 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"`
}
IAMCredentialsSecretVersionPrototype : IAMCredentialsSecretVersionPrototype struct This model "extends" SecretVersionPrototype
type ImportedCertificate ¶
type ImportedCertificate struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
// certificate.
SigningAlgorithm *string `json:"signing_algorithm" validate:"required"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The Common Name (CN) represents the server name protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date" validate:"required"`
// Indicates whether the certificate was imported with an associated intermediate certificate.
IntermediateIncluded *bool `json:"intermediate_included" validate:"required"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer" validate:"required"`
// The identifier for the cryptographic algorithm used to generate the public key that is associated with the
// certificate.
KeyAlgorithm *string `json:"key_algorithm,omitempty"`
// Indicates whether the certificate was imported with an associated private key.
PrivateKeyIncluded *bool `json:"private_key_included" validate:"required"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number" validate:"required"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity" validate:"required"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
}
ImportedCertificate : Your imported certificate. This model "extends" Secret
type ImportedCertificateMetadata ¶
type ImportedCertificateMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
// certificate.
SigningAlgorithm *string `json:"signing_algorithm" validate:"required"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The Common Name (CN) represents the server name protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date" validate:"required"`
// Indicates whether the certificate was imported with an associated intermediate certificate.
IntermediateIncluded *bool `json:"intermediate_included" validate:"required"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer" validate:"required"`
// The identifier for the cryptographic algorithm used to generate the public key that is associated with the
// certificate.
KeyAlgorithm *string `json:"key_algorithm,omitempty"`
// Indicates whether the certificate was imported with an associated private key.
PrivateKeyIncluded *bool `json:"private_key_included" validate:"required"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number" validate:"required"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity" validate:"required"`
}
ImportedCertificateMetadata : Properties of the secret metadata of your imported certificate. This model "extends" SecretMetadata
type ImportedCertificateMetadataPatch ¶
type ImportedCertificateMetadataPatch struct {
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
}
ImportedCertificateMetadataPatch : ImportedCertificateMetadataPatch struct This model "extends" SecretMetadataPatch
func (*ImportedCertificateMetadataPatch) AsPatch ¶
func (importedCertificateMetadataPatch *ImportedCertificateMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the ImportedCertificateMetadataPatch
type ImportedCertificatePrototype ¶
type ImportedCertificatePrototype struct {
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,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"`
}
ImportedCertificatePrototype : ImportedCertificatePrototype struct This model "extends" SecretPrototype
type ImportedCertificateVersion ¶
type ImportedCertificateVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date" validate:"required"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number" validate:"required"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity" validate:"required"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
}
ImportedCertificateVersion : Versions of your imported certificate. This model "extends" SecretVersion
type ImportedCertificateVersionMetadata ¶
type ImportedCertificateVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date" validate:"required"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number" validate:"required"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity" validate:"required"`
}
ImportedCertificateVersionMetadata : Properties of the version metadata of your imported certificate. This model "extends" SecretVersionMetadata
type ImportedCertificateVersionPrototype ¶
type ImportedCertificateVersionPrototype struct {
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,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"`
}
ImportedCertificateVersionPrototype : ImportedCertificateVersionPrototype struct This model "extends" SecretVersionPrototype
type KVSecret ¶
type KVSecret struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The payload data of a key-value secret.
Data map[string]interface{} `json:"data" validate:"required"`
}
KVSecret : Your key-value secret. This model "extends" Secret
type KVSecretMetadata ¶
type KVSecretMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
}
KVSecretMetadata : Properties of the metadata of your key-value secret metadata. This model "extends" SecretMetadata
type KVSecretMetadataPatch ¶
type KVSecretMetadataPatch struct {
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
}
KVSecretMetadataPatch : KVSecretMetadataPatch struct This model "extends" SecretMetadataPatch
func (*KVSecretMetadataPatch) AsPatch ¶
func (kVSecretMetadataPatch *KVSecretMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the KVSecretMetadataPatch
type KVSecretPrototype ¶
type KVSecretPrototype struct {
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 payload data of a key-value secret.
Data map[string]interface{} `json:"data" 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"`
}
KVSecretPrototype : KVSecretPrototype struct This model "extends" SecretPrototype
type KVSecretVersion ¶
type KVSecretVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The payload data of a key-value secret.
Data map[string]interface{} `json:"data" validate:"required"`
}
KVSecretVersion : Your key-value secret version. This model "extends" SecretVersion
type KVSecretVersionMetadata ¶
type KVSecretVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
}
KVSecretVersionMetadata : Properties of the version metadata of your key-value secret. This model "extends" SecretVersionMetadata
type KVSecretVersionPrototype ¶
type KVSecretVersionPrototype struct {
// The payload data of a key-value secret.
Data map[string]interface{} `json:"data" 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"`
}
KVSecretVersionPrototype : KVSecretVersionPrototype struct This model "extends" SecretVersionPrototype
type ListConfigurationsOptions ¶
type ListConfigurationsOptions struct {
// The number of configurations 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 configurations in your instance, and you want to retrieve configurations 26 through 50,
// use
// `..?offset=25&limit=25`.
Offset *int64 `json:"offset,omitempty"`
// The number of configurations 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. Maximum limit allowed is
// 1000 secrets.
//
// **Usage:** If you want to retrieve only the first 25 configurations in your instance, use
// `..?limit=25`.
Limit *int64 `json:"limit,omitempty"`
// Sort a collection of configurations by the specified field in ascending order. To sort in descending order use the
// `-` character
//
//
// **Available values:** config_type | secret_type | name
//
// **Usage:** To sort a list of configurations by their creation date, use
// `../configurations?sort=config_type`.
Sort *string `json:"sort,omitempty"`
// Obtain a collection of configurations that contain the specified string in one or more of the fields: `name`,
// `config_type`, `secret_type`.
//
// **Usage:** If you want to list only the configurations that contain the string `text`, use
// `../configurations?search=text`.
Search *string `json:"search,omitempty"`
// Allows users to set headers on API requests
Headers map[string]string
}
ListConfigurationsOptions : The ListConfigurations options.
func (*ListConfigurationsOptions) SetHeaders ¶
func (options *ListConfigurationsOptions) SetHeaders(param map[string]string) *ListConfigurationsOptions
SetHeaders : Allow user to set Headers
func (*ListConfigurationsOptions) SetLimit ¶
func (_options *ListConfigurationsOptions) SetLimit(limit int64) *ListConfigurationsOptions
SetLimit : Allow user to set Limit
func (*ListConfigurationsOptions) SetOffset ¶
func (_options *ListConfigurationsOptions) SetOffset(offset int64) *ListConfigurationsOptions
SetOffset : Allow user to set Offset
func (*ListConfigurationsOptions) SetSearch ¶
func (_options *ListConfigurationsOptions) SetSearch(search string) *ListConfigurationsOptions
SetSearch : Allow user to set Search
func (*ListConfigurationsOptions) SetSort ¶
func (_options *ListConfigurationsOptions) SetSort(sort string) *ListConfigurationsOptions
SetSort : Allow user to set Sort
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 ListSecretLocksOptions ¶
type ListSecretLocksOptions struct {
// The v4 UUID that uniquely identifies your secret.
ID *string `json:"id" validate:"required,ne="`
// 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"`
// The number of locks with associated secret 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"`
// Sort a collection of locks by the specified field in ascending order. To sort in descending order use the `-`
// character
//
// **Available values:** created_at | updated_at | name
//
// **Usage:** To sort a list of locks by their creation date, use
// `../locks?sort=created_at`.
Sort *string `json:"sort,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
}
ListSecretLocksOptions : The ListSecretLocks options.
func (*ListSecretLocksOptions) SetHeaders ¶
func (options *ListSecretLocksOptions) SetHeaders(param map[string]string) *ListSecretLocksOptions
SetHeaders : Allow user to set Headers
func (*ListSecretLocksOptions) SetID ¶
func (_options *ListSecretLocksOptions) SetID(id string) *ListSecretLocksOptions
SetID : Allow user to set ID
func (*ListSecretLocksOptions) SetLimit ¶
func (_options *ListSecretLocksOptions) SetLimit(limit int64) *ListSecretLocksOptions
SetLimit : Allow user to set Limit
func (*ListSecretLocksOptions) SetOffset ¶
func (_options *ListSecretLocksOptions) SetOffset(offset int64) *ListSecretLocksOptions
SetOffset : Allow user to set Offset
func (*ListSecretLocksOptions) SetSearch ¶
func (_options *ListSecretLocksOptions) SetSearch(search string) *ListSecretLocksOptions
SetSearch : Allow user to set Search
func (*ListSecretLocksOptions) SetSort ¶
func (_options *ListSecretLocksOptions) SetSort(sort string) *ListSecretLocksOptions
SetSort : Allow user to set Sort
type ListSecretVersionLocksOptions ¶
type ListSecretVersionLocksOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// The v4 UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer
// to the current or previous secret version.
ID *string `json:"id" validate:"required,ne="`
// 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"`
// The number of locks with associated secret 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"`
// Sort a collection of locks by the specified field in ascending order. To sort in descending order use the `-`
// character
//
// **Available values:** created_at | updated_at | name
//
// **Usage:** To sort a list of locks by their creation date, use
// `../locks?sort=created_at`.
Sort *string `json:"sort,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
}
ListSecretVersionLocksOptions : The ListSecretVersionLocks options.
func (*ListSecretVersionLocksOptions) SetHeaders ¶
func (options *ListSecretVersionLocksOptions) SetHeaders(param map[string]string) *ListSecretVersionLocksOptions
SetHeaders : Allow user to set Headers
func (*ListSecretVersionLocksOptions) SetID ¶
func (_options *ListSecretVersionLocksOptions) SetID(id string) *ListSecretVersionLocksOptions
SetID : Allow user to set ID
func (*ListSecretVersionLocksOptions) SetLimit ¶
func (_options *ListSecretVersionLocksOptions) SetLimit(limit int64) *ListSecretVersionLocksOptions
SetLimit : Allow user to set Limit
func (*ListSecretVersionLocksOptions) SetOffset ¶
func (_options *ListSecretVersionLocksOptions) SetOffset(offset int64) *ListSecretVersionLocksOptions
SetOffset : Allow user to set Offset
func (*ListSecretVersionLocksOptions) SetSearch ¶
func (_options *ListSecretVersionLocksOptions) SetSearch(search string) *ListSecretVersionLocksOptions
SetSearch : Allow user to set Search
func (*ListSecretVersionLocksOptions) SetSecretID ¶
func (_options *ListSecretVersionLocksOptions) SetSecretID(secretID string) *ListSecretVersionLocksOptions
SetSecretID : Allow user to set SecretID
func (*ListSecretVersionLocksOptions) SetSort ¶
func (_options *ListSecretVersionLocksOptions) SetSort(sort string) *ListSecretVersionLocksOptions
SetSort : Allow user to set Sort
type ListSecretVersionsOptions ¶
type ListSecretVersionsOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// Allows users to set headers on API requests
Headers map[string]string
}
ListSecretVersionsOptions : The ListSecretVersions options.
func (*ListSecretVersionsOptions) SetHeaders ¶
func (options *ListSecretVersionsOptions) SetHeaders(param map[string]string) *ListSecretVersionsOptions
SetHeaders : Allow user to set Headers
func (*ListSecretVersionsOptions) SetSecretID ¶
func (_options *ListSecretVersionsOptions) SetSecretID(secretID string) *ListSecretVersionsOptions
SetSecretID : Allow user to set SecretID
type ListSecretsLocksOptions ¶
type ListSecretsLocksOptions struct {
// 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"`
// 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. Maximum limit allowed is 1000
// secrets.
//
// **Usage:** If you want to retrieve only the first 25 secrets in your instance, use
// `..?limit=25`.
Limit *int64 `json:"limit,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
}
ListSecretsLocksOptions : The ListSecretsLocks options.
func (*ListSecretsLocksOptions) SetGroups ¶
func (_options *ListSecretsLocksOptions) SetGroups(groups []string) *ListSecretsLocksOptions
SetGroups : Allow user to set Groups
func (*ListSecretsLocksOptions) SetHeaders ¶
func (options *ListSecretsLocksOptions) SetHeaders(param map[string]string) *ListSecretsLocksOptions
SetHeaders : Allow user to set Headers
func (*ListSecretsLocksOptions) SetLimit ¶
func (_options *ListSecretsLocksOptions) SetLimit(limit int64) *ListSecretsLocksOptions
SetLimit : Allow user to set Limit
func (*ListSecretsLocksOptions) SetOffset ¶
func (_options *ListSecretsLocksOptions) SetOffset(offset int64) *ListSecretsLocksOptions
SetOffset : Allow user to set Offset
func (*ListSecretsLocksOptions) SetSearch ¶
func (_options *ListSecretsLocksOptions) SetSearch(search string) *ListSecretsLocksOptions
SetSearch : Allow user to set Search
type ListSecretsOptions ¶
type ListSecretsOptions struct {
// 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"`
// 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. Maximum limit allowed is 1000
// secrets.
//
// **Usage:** If you want to retrieve only the first 25 secrets in your instance, use
// `..?limit=25`.
Limit *int64 `json:"limit,omitempty"`
// Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the `-`
// character
//
//
// **Available values:** id | created_at | updated_at | expiration_date | secret_type | name
//
// **Usage:** To sort a list of secrets by their creation date, use
// `../secrets?sort=created_at`.
Sort *string `json:"sort,omitempty"`
// Obtain a collection of secrets that contain the specified string in one or more of the fields: `id`, `name`,
// `description`,
// `labels`, `secret_type`.
//
// **Usage:** If you want to list only the secrets that contain the string `text`, use
// `../secrets?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"`
// Filter secrets by types.
//
// You can apply multiple filters by using a comma-separated list of secret types.
//
// **Usage:** To retrieve a list of imported certificates and public certificates use
// `..?secret_types=imported_cert,public_cert`.
SecretTypes []string `json:"secret_types,omitempty"`
// Filter secrets by labels.
//
// You can use a comma-separated list of labels to filter secrets that include all of the labels in the list.
//
// **Usage:** To retrieve a list of secrets that include both the label "dev" and the label "us-south" in their list of
// labels, use `..?labels=dev,us-south`.
MatchAllLabels []string `json:"match_all_labels,omitempty"`
// Allows users to set headers on API requests
Headers map[string]string
}
ListSecretsOptions : The ListSecrets options.
func (*ListSecretsOptions) SetGroups ¶
func (_options *ListSecretsOptions) SetGroups(groups []string) *ListSecretsOptions
SetGroups : Allow user to set Groups
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) SetMatchAllLabels ¶ added in v2.0.4
func (_options *ListSecretsOptions) SetMatchAllLabels(matchAllLabels []string) *ListSecretsOptions
SetMatchAllLabels : Allow user to set MatchAllLabels
func (*ListSecretsOptions) SetOffset ¶
func (_options *ListSecretsOptions) SetOffset(offset int64) *ListSecretsOptions
SetOffset : Allow user to set Offset
func (*ListSecretsOptions) SetSearch ¶
func (_options *ListSecretsOptions) SetSearch(search string) *ListSecretsOptions
SetSearch : Allow user to set Search
func (*ListSecretsOptions) SetSecretTypes ¶ added in v2.0.4
func (_options *ListSecretsOptions) SetSecretTypes(secretTypes []string) *ListSecretsOptions
SetSecretTypes : Allow user to set SecretTypes
func (*ListSecretsOptions) SetSort ¶
func (_options *ListSecretsOptions) SetSort(sort string) *ListSecretsOptions
SetSort : Allow user to set Sort
type NotificationsRegistration ¶
type NotificationsRegistration struct {
// A CRN that uniquely identifies an IBM Cloud resource.
EventNotificationsInstanceCrn *string `json:"event_notifications_instance_crn" validate:"required"`
}
NotificationsRegistration : The details of the Event Notifications registration.
type PaginatedCollectionFirst ¶
type PaginatedCollectionFirst struct {
// A URL that points to a page in a collection.
Href *string `json:"href" validate:"required"`
}
PaginatedCollectionFirst : A URL that points to the first page in a collection.
type PaginatedCollectionLast ¶
type PaginatedCollectionLast struct {
// A URL that points to a page in a collection.
Href *string `json:"href" validate:"required"`
}
PaginatedCollectionLast : A URL that points to the last page in a collection.
type PaginatedCollectionNext ¶
type PaginatedCollectionNext struct {
// A URL that points to a page in a collection.
Href *string `json:"href" validate:"required"`
}
PaginatedCollectionNext : A URL that points to the next page in a collection.
type PaginatedCollectionPrevious ¶
type PaginatedCollectionPrevious struct {
// A URL that points to a page in a collection.
Href *string `json:"href" validate:"required"`
}
PaginatedCollectionPrevious : A URL that points to the previous page in a collection.
type PasswordGenerationPolicy ¶ added in v2.0.3
type PasswordGenerationPolicy struct {
// The length of auto-generated passwords.
Length *int64 `json:"length,omitempty"`
// Include digits in auto-generated passwords.
IncludeDigits *bool `json:"include_digits,omitempty"`
// Include symbols in auto-generated passwords.
IncludeSymbols *bool `json:"include_symbols,omitempty"`
// Include uppercase letters in auto-generated passwords.
IncludeUppercase *bool `json:"include_uppercase,omitempty"`
}
PasswordGenerationPolicy : Policy for auto-generated passwords.
type PasswordGenerationPolicyPatch ¶ added in v2.0.3
type PasswordGenerationPolicyPatch struct {
// The length of auto-generated passwords.
Length *int64 `json:"length,omitempty"`
// Include digits in auto-generated passwords.
IncludeDigits *bool `json:"include_digits,omitempty"`
// Include symbols in auto-generated passwords.
IncludeSymbols *bool `json:"include_symbols,omitempty"`
// Include uppercase letters in auto-generated passwords.
IncludeUppercase *bool `json:"include_uppercase,omitempty"`
}
PasswordGenerationPolicyPatch : Policy patch for auto-generated passwords. Policy properties that are included in the patch are updated. Properties that are not included in the patch remain unchanged.
type PasswordGenerationPolicyRO ¶ added in v2.0.3
type PasswordGenerationPolicyRO struct {
// The length of auto-generated passwords.
Length *int64 `json:"length,omitempty"`
// Include digits in auto-generated passwords.
IncludeDigits *bool `json:"include_digits,omitempty"`
// Include symbols in auto-generated passwords.
IncludeSymbols *bool `json:"include_symbols,omitempty"`
// Include uppercase letters in auto-generated passwords.
IncludeUppercase *bool `json:"include_uppercase,omitempty"`
}
PasswordGenerationPolicyRO : Policy for auto-generated passwords.
type PrivateCertificate ¶
type PrivateCertificate struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
// certificate.
SigningAlgorithm *string `json:"signing_algorithm" validate:"required"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The intermediate certificate authority that signed this certificate.
CertificateAuthority *string `json:"certificate_authority,omitempty"`
// The name of the certificate template.
CertificateTemplate *string `json:"certificate_template" validate:"required"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date" validate:"required"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer" validate:"required"`
// The identifier for the cryptographic algorithm used to generate the public key that is associated with the
// certificate.
KeyAlgorithm *string `json:"key_algorithm,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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number" validate:"required"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity" validate:"required"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
// The date and time that the certificate was revoked. The date format follows `RFC 3339`.
RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key" validate:"required"`
// 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"`
}
PrivateCertificate : Your private certificate. This model "extends" Secret
type PrivateCertificateActionRevoke ¶
type PrivateCertificateActionRevoke struct {
// The type of secret action.
ActionType *string `json:"action_type" validate:"required"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
}
PrivateCertificateActionRevoke : The response body of the action to revoke the private certificate. This model "extends" SecretAction
type PrivateCertificateActionRevokePrototype ¶
type PrivateCertificateActionRevokePrototype struct {
// The type of secret action.
ActionType *string `json:"action_type" validate:"required"`
}
PrivateCertificateActionRevokePrototype : The request body to specify the properties of the action to revoke the private certificate. This model "extends" SecretActionPrototype
type PrivateCertificateCAData ¶
type PrivateCertificateCAData struct {
// The certificate signing request.
Csr *string `json:"csr,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
// The type of private key to generate.
PrivateKeyType *string `json:"private_key_type,omitempty"`
// The certificate expiration time.
Expiration *int64 `json:"expiration,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,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"`
}
PrivateCertificateCAData : The configuration data of your Private Certificate. Models which "extend" this model: - PrivateCertificateConfigurationIntermediateCACSR - PrivateCertificateConfigurationCACertificate
type PrivateCertificateCADataIntf ¶
type PrivateCertificateCADataIntf interface {
// contains filtered or unexported methods
}
type PrivateCertificateConfigurationActionRevoke ¶
type PrivateCertificateConfigurationActionRevoke struct {
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
}
PrivateCertificateConfigurationActionRevoke : The response body to specify the properties of the action to revoke the private certificate. This model "extends" ConfigurationAction
type PrivateCertificateConfigurationActionRevokePrototype ¶
type PrivateCertificateConfigurationActionRevokePrototype struct {
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
}
PrivateCertificateConfigurationActionRevokePrototype : The request body to specify the properties of the action to revoke the private certificate configuration. This model "extends" ConfigurationActionPrototype
type PrivateCertificateConfigurationActionRotateCRL ¶
type PrivateCertificateConfigurationActionRotateCRL struct {
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
// This field indicates whether the request to rotate the CRL for the private certificate configuration was successful.
Success *bool `json:"success" validate:"required"`
}
PrivateCertificateConfigurationActionRotateCRL : The response body of the action to rotate the CRL of an intermediate certificate authority for the private certificate configuration. This model "extends" ConfigurationAction
type PrivateCertificateConfigurationActionRotateCRLPrototype ¶
type PrivateCertificateConfigurationActionRotateCRLPrototype struct {
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
}
PrivateCertificateConfigurationActionRotateCRLPrototype : The request body of the action to rotate the CRL of an intermediate certificate authority for the private certificate configuration. This model "extends" ConfigurationActionPrototype
type PrivateCertificateConfigurationActionSetSigned ¶
type PrivateCertificateConfigurationActionSetSigned struct {
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
}
PrivateCertificateConfigurationActionSetSigned : The response body of the action to set a signed intermediate certificate authority for the private certificate configuration. This model "extends" ConfigurationAction
type PrivateCertificateConfigurationActionSetSignedPrototype ¶
type PrivateCertificateConfigurationActionSetSignedPrototype struct {
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
}
PrivateCertificateConfigurationActionSetSignedPrototype : The request body of the action to set a signed intermediate certificate authority for the private certificate consideration. This model "extends" ConfigurationActionPrototype
type PrivateCertificateConfigurationActionSignCSR ¶
type PrivateCertificateConfigurationActionSignCSR struct {
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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, for example '12h'. The value can't
// exceed the `max_ttl` that is defined in the associated certificate template.
TTL *string `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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.
PermittedDnsDomains []string `json:"permitted_dns_domains,omitempty"`
// This field indicates whether to use values from a certificate signing request (CSR) to complete a
// `private_cert_configuration_action_sign_csr` action. If it is set to `true`, then:
//
// 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
// values that are provided in the other parameters to this operation.
//
// 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
// usages used for CA certificates that are signed by the 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,omitempty"`
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
// The certificate signing request.
Csr *string `json:"csr" validate:"required"`
// The data that is associated with the root certificate authority.
Data *PrivateCertificateConfigurationCACertificate `json:"data,omitempty"`
}
PrivateCertificateConfigurationActionSignCSR : The response body of the action to sign the CSR for the private certificate configuration. This model "extends" ConfigurationAction
type PrivateCertificateConfigurationActionSignCSRPrototype ¶
type PrivateCertificateConfigurationActionSignCSRPrototype struct {
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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, for example '12h'. The value can't
// exceed the `max_ttl` that is defined in the associated certificate template.
TTL *string `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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.
PermittedDnsDomains []string `json:"permitted_dns_domains,omitempty"`
// This field indicates whether to use values from a certificate signing request (CSR) to complete a
// `private_cert_configuration_action_sign_csr` action. If it is set to `true`, then:
//
// 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
// values that are provided in the other parameters to this operation.
//
// 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
// usages used for CA certificates that are signed by the 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,omitempty"`
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
// The certificate signing request.
Csr *string `json:"csr" validate:"required"`
}
PrivateCertificateConfigurationActionSignCSRPrototype : The request body to specify the properties of the action to sign a CSR for the private certificate configuration. This model "extends" ConfigurationActionPrototype
type PrivateCertificateConfigurationActionSignIntermediate ¶
type PrivateCertificateConfigurationActionSignIntermediate struct {
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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, for example '12h'. The value can't
// exceed the `max_ttl` that is defined in the associated certificate template.
TTL *string `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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.
PermittedDnsDomains []string `json:"permitted_dns_domains,omitempty"`
// This field indicates whether to use values from a certificate signing request (CSR) to complete a
// `private_cert_configuration_action_sign_csr` action. If it is set to `true`, then:
//
// 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
// values that are provided in the other parameters to this operation.
//
// 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
// usages used for CA certificates that are signed by the 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,omitempty"`
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
// The name of the intermediate certificate authority configuration.
IntermediateCertificateAuthority *string `json:"intermediate_certificate_authority" validate:"required"`
}
PrivateCertificateConfigurationActionSignIntermediate : The response body of the action to sign the intermediate certificate authority for the private certificate configuration. This model "extends" ConfigurationAction
type PrivateCertificateConfigurationActionSignIntermediatePrototype ¶
type PrivateCertificateConfigurationActionSignIntermediatePrototype struct {
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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, for example '12h'. The value can't
// exceed the `max_ttl` that is defined in the associated certificate template.
TTL *string `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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.
PermittedDnsDomains []string `json:"permitted_dns_domains,omitempty"`
// This field indicates whether to use values from a certificate signing request (CSR) to complete a
// `private_cert_configuration_action_sign_csr` action. If it is set to `true`, then:
//
// 1) Subject information, including names and alternate names, are preserved from the CSR rather than by using the
// values that are provided in the other parameters to this operation.
//
// 2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set of key
// usages used for CA certificates that are signed by the 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,omitempty"`
// The type of configuration action.
ActionType *string `json:"action_type" validate:"required"`
// The name of the intermediate certificate authority configuration.
IntermediateCertificateAuthority *string `json:"intermediate_certificate_authority" validate:"required"`
}
PrivateCertificateConfigurationActionSignIntermediatePrototype : The request body to specify the properties of the action to sign an intermediate certificate authority for the private certificate configuration. This model "extends" ConfigurationActionPrototype
type PrivateCertificateConfigurationCACertificate ¶
type PrivateCertificateConfigurationCACertificate struct {
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
// 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 certificate expiration time.
Expiration *int64 `json:"expiration,omitempty"`
}
PrivateCertificateConfigurationCACertificate : The data that is associated with the root certificate authority. This model "extends" PrivateCertificateCAData
type PrivateCertificateConfigurationIntermediateCA ¶
type PrivateCertificateConfigurationIntermediateCA struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// This field 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"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 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 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 maximum time-to-live (TTL) for certificates that are created by this CA in seconds.
MaxTtlSeconds *int64 `json:"max_ttl_seconds,omitempty"`
// The time until the certificate revocation list (CRL) expires, in seconds.
CrlExpirySeconds *int64 `json:"crl_expiry_seconds,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The configuration data of your Private Certificate.
Data PrivateCertificateCADataIntf `json:"data,omitempty"`
}
PrivateCertificateConfigurationIntermediateCA : The configuration of the root certificate authority. This model "extends" Configuration
type PrivateCertificateConfigurationIntermediateCACSR ¶
type PrivateCertificateConfigurationIntermediateCACSR struct {
// The certificate signing request.
Csr *string `json:"csr,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
// The type of private key to generate.
PrivateKeyType *string `json:"private_key_type,omitempty"`
// The certificate expiration time.
Expiration *int64 `json:"expiration,omitempty"`
}
PrivateCertificateConfigurationIntermediateCACSR : The data that is associated with the intermediate certificate authority. This model "extends" PrivateCertificateCAData
type PrivateCertificateConfigurationIntermediateCAMetadata ¶
type PrivateCertificateConfigurationIntermediateCAMetadata struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// This field 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"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 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 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"`
}
PrivateCertificateConfigurationIntermediateCAMetadata : The configuration of the metadata properties of the intermediate certificate authority. This model "extends" ConfigurationMetadata
type PrivateCertificateConfigurationIntermediateCAPatch ¶
type PrivateCertificateConfigurationIntermediateCAPatch 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 *string `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 *string `json:"crl_expiry,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// This field 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"`
}
PrivateCertificateConfigurationIntermediateCAPatch : The configuration patch of the intermediate certificate authority. This model "extends" ConfigurationPatch
func (*PrivateCertificateConfigurationIntermediateCAPatch) AsPatch ¶
func (privateCertificateConfigurationIntermediateCAPatch *PrivateCertificateConfigurationIntermediateCAPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the PrivateCertificateConfigurationIntermediateCAPatch
type PrivateCertificateConfigurationIntermediateCAPrototype ¶
type PrivateCertificateConfigurationIntermediateCAPrototype struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// A human-readable unique name to assign to your configuration.
//
// To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
Name *string `json:"name" validate:"required"`
// 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 *string `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 distinguished name that identifies the entity that signed and issued the certificate.
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 *string `json:"crl_expiry,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// This field 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 Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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 to generate 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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,omitempty"`
}
PrivateCertificateConfigurationIntermediateCAPrototype : The configuration of the intermediate certificate authority. This model "extends" ConfigurationPrototype
type PrivateCertificateConfigurationRootCA ¶
type PrivateCertificateConfigurationRootCA struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// This field 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"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 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 maximum time-to-live (TTL) for certificates that are created by this CA in seconds.
MaxTtlSeconds *int64 `json:"max_ttl_seconds,omitempty"`
// The time until the certificate revocation list (CRL) expires, in seconds.
CrlExpirySeconds *int64 `json:"crl_expiry_seconds,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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"`
// he requested TTL, after which the certificate expires.
TtlSeconds *int64 `json:"ttl_seconds,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 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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The configuration data of your Private Certificate.
Data PrivateCertificateCADataIntf `json:"data,omitempty"`
}
PrivateCertificateConfigurationRootCA : The root certificate authority . This model "extends" Configuration
type PrivateCertificateConfigurationRootCAMetadata ¶
type PrivateCertificateConfigurationRootCAMetadata struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// This field 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"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 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"`
}
PrivateCertificateConfigurationRootCAMetadata : The configuration of the metadata properties of the root certificate authority. This model "extends" ConfigurationMetadata
type PrivateCertificateConfigurationRootCAPatch ¶
type PrivateCertificateConfigurationRootCAPatch 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 *string `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 *string `json:"crl_expiry,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// This field 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"`
}
PrivateCertificateConfigurationRootCAPatch : The configuration of the metadata patch for the root certificate authority. This model "extends" ConfigurationPatch
func (*PrivateCertificateConfigurationRootCAPatch) AsPatch ¶
func (privateCertificateConfigurationRootCAPatch *PrivateCertificateConfigurationRootCAPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the PrivateCertificateConfigurationRootCAPatch
type PrivateCertificateConfigurationRootCAPrototype ¶
type PrivateCertificateConfigurationRootCAPrototype struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// A human-readable unique name to assign to your configuration.
//
// To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
Name *string `json:"name" validate:"required"`
// 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 *string `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 *string `json:"crl_expiry,omitempty"`
// This field disables or enables certificate revocation list (CRL) building.
//
// If CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL
// building is enabled, it rebuilds the CRL.
CrlDisable *bool `json:"crl_disable,omitempty"`
// This field 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"`
// This field 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 Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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 requested time-to-live (TTL) for certificates that are created by this CA. This field's value can't be longer
// than the `max_ttl` limit.
//
// 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).
TTL *string `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 to generate 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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The allowed DNS domains or subdomains for the certificates that are 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute
// that is in the certificate's distinguished name (DN).
//
// **Note:** This field is not related to the `serial_number` field that is returned in the API response. The
// `serial_number` field represents the certificate's randomly assigned serial number.
SerialNumber *string `json:"serial_number,omitempty"`
}
PrivateCertificateConfigurationRootCAPrototype : The configuration of the root certificate authority. This model "extends" ConfigurationPrototype
type PrivateCertificateConfigurationTemplate ¶
type PrivateCertificateConfigurationTemplate struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The name of the intermediate certificate authority.
CertificateAuthority *string `json:"certificate_authority" validate:"required"`
// This field 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 in seconds.
MaxTtlSeconds *int64 `json:"max_ttl_seconds,omitempty"`
// he requested TTL, after which the certificate expires.
TtlSeconds *int64 `json:"ttl_seconds,omitempty"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates whether to allow clients to request a private certificate that matches any common name.
AllowAnyName *bool `json:"allow_any_name,omitempty"`
// This field indicates whether to enforce only valid hostnames for common names, DNS Subject Alternative Names, and
// the host section of email addresses.
EnforceHostnames *bool `json:"enforce_hostnames,omitempty"`
// This field indicates 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"`
// This field indicates whether private certificates are flagged for server use.
ServerFlag *bool `json:"server_flag,omitempty"`
// This field indicates whether private certificates are flagged for client use.
ClientFlag *bool `json:"client_flag,omitempty"`
// This field indicates whether private certificates are flagged for code signing use.
CodeSigningFlag *bool `json:"code_signing_flag,omitempty"`
// This field indicates whether private certificates are flagged for email protection use.
EmailProtectionFlag *bool `json:"email_protection_flag,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 `private_cert_configuration_action_sign_csr` action, this field determines whether to use the
// common name (CN) from a certificate signing request (CSR) instead of the CN that is included in the 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 `private_cert_configuration_action_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 data of the
// certificate.
//
// This field 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// This field is deprecated. You can ignore its value.
SerialNumber *string `json:"serial_number,omitempty"`
// This field indicates 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"`
// This field indicates 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.
NotBeforeDurationSeconds *int64 `json:"not_before_duration_seconds,omitempty"`
}
PrivateCertificateConfigurationTemplate : The configuration of the private certificate template. This model "extends" Configuration
type PrivateCertificateConfigurationTemplateMetadata ¶
type PrivateCertificateConfigurationTemplateMetadata struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The name of the intermediate certificate authority.
CertificateAuthority *string `json:"certificate_authority" validate:"required"`
}
PrivateCertificateConfigurationTemplateMetadata : The metadata properties of the configuration of the private certificate template. This model "extends" ConfigurationMetadata
type PrivateCertificateConfigurationTemplatePatch ¶
type PrivateCertificateConfigurationTemplatePatch struct {
// This field 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 *string `json:"max_ttl,omitempty"`
// The requested time-to-live (TTL) for certificates that are created by this CA. This field's value can't be longer
// than the `max_ttl` limit.
//
// 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).
TTL *string `json:"ttl,omitempty"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates whether to allow clients to request a private certificate that matches any common name.
AllowAnyName *bool `json:"allow_any_name,omitempty"`
// This field indicates whether to enforce only valid hostnames for common names, DNS Subject Alternative Names, and
// the host section of email addresses.
EnforceHostnames *bool `json:"enforce_hostnames,omitempty"`
// This field indicates 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"`
// This field indicates whether private certificates are flagged for server use.
ServerFlag *bool `json:"server_flag,omitempty"`
// This field indicates whether private certificates are flagged for client use.
ClientFlag *bool `json:"client_flag,omitempty"`
// This field indicates whether private certificates are flagged for code signing use.
CodeSigningFlag *bool `json:"code_signing_flag,omitempty"`
// This field indicates whether private certificates are flagged for email protection use.
EmailProtectionFlag *bool `json:"email_protection_flag,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 `private_cert_configuration_action_sign_csr` action, this field determines whether to use the
// common name (CN) from a certificate signing request (CSR) instead of the CN that is included in the 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 `private_cert_configuration_action_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 data of the
// certificate.
//
// This field 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// This field is deprecated. You can ignore its value.
SerialNumber *string `json:"serial_number,omitempty"`
// This field indicates 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"`
// This field indicates 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 *string `json:"not_before_duration,omitempty"`
}
PrivateCertificateConfigurationTemplatePatch : 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" ConfigurationPatch
func (*PrivateCertificateConfigurationTemplatePatch) AsPatch ¶
func (privateCertificateConfigurationTemplatePatch *PrivateCertificateConfigurationTemplatePatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the PrivateCertificateConfigurationTemplatePatch
type PrivateCertificateConfigurationTemplatePrototype ¶
type PrivateCertificateConfigurationTemplatePrototype struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// A human-readable unique name to assign to your configuration.
//
// To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
Name *string `json:"name" validate:"required"`
// The name of the intermediate certificate authority.
CertificateAuthority *string `json:"certificate_authority" validate:"required"`
// This field 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 *string `json:"max_ttl,omitempty"`
// The requested time-to-live (TTL) for certificates that are created by this CA. This field's value can't be longer
// than the `max_ttl` limit.
//
// 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).
TTL *string `json:"ttl,omitempty"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates 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"`
// This field indicates whether the issuance of certificates with RFC 6125 wildcards in the CN field.
//
// When set to false, this field prevents wildcards from being issued even if they can be allowed by an option
// `allow_glob_domains`.
AllowWildcardCertificates *bool `json:"allow_wildcard_certificates,omitempty"`
// This field indicates whether to allow clients to request a private certificate that matches any common name.
AllowAnyName *bool `json:"allow_any_name,omitempty"`
// This field indicates whether to enforce only valid hostnames for common names, DNS Subject Alternative Names, and
// the host section of email addresses.
EnforceHostnames *bool `json:"enforce_hostnames,omitempty"`
// This field indicates 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"`
// This field indicates whether private certificates are flagged for server use.
ServerFlag *bool `json:"server_flag,omitempty"`
// This field indicates whether private certificates are flagged for client use.
ClientFlag *bool `json:"client_flag,omitempty"`
// This field indicates whether private certificates are flagged for code signing use.
CodeSigningFlag *bool `json:"code_signing_flag,omitempty"`
// This field indicates whether private certificates are flagged for email protection use.
EmailProtectionFlag *bool `json:"email_protection_flag,omitempty"`
// The type of private key to generate.
KeyType *string `json:"key_type,omitempty"`
// The number of bits to use to generate 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 `private_cert_configuration_action_sign_csr` action, this field determines whether to use the
// common name (CN) from a certificate signing request (CSR) instead of the CN that is included in the 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 `private_cert_configuration_action_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 data of the
// certificate.
//
// This field 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 to define in the subject field of the resulting certificate.
StreetAddress []string `json:"street_address,omitempty"`
// The postal code values to define in the subject field of the resulting certificate.
PostalCode []string `json:"postal_code,omitempty"`
// This field is deprecated. You can ignore its value.
SerialNumber *string `json:"serial_number,omitempty"`
// This field indicates 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"`
// This field indicates 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 *string `json:"not_before_duration,omitempty"`
}
PrivateCertificateConfigurationTemplatePrototype : 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" ConfigurationPrototype
type PrivateCertificateMetadata ¶
type PrivateCertificateMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
// certificate.
SigningAlgorithm *string `json:"signing_algorithm" validate:"required"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The intermediate certificate authority that signed this certificate.
CertificateAuthority *string `json:"certificate_authority,omitempty"`
// The name of the certificate template.
CertificateTemplate *string `json:"certificate_template" validate:"required"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date" validate:"required"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer" validate:"required"`
// The identifier for the cryptographic algorithm used to generate the public key that is associated with the
// certificate.
KeyAlgorithm *string `json:"key_algorithm,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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number" validate:"required"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity" validate:"required"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
// The date and time that the certificate was revoked. The date format follows `RFC 3339`.
RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
}
PrivateCertificateMetadata : Properties of the metadata of your private certificate. This model "extends" SecretMetadata
type PrivateCertificateMetadataPatch ¶
type PrivateCertificateMetadataPatch struct {
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
}
PrivateCertificateMetadataPatch : PrivateCertificateMetadataPatch struct This model "extends" SecretMetadataPatch
func (*PrivateCertificateMetadataPatch) AsPatch ¶
func (privateCertificateMetadataPatch *PrivateCertificateMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the PrivateCertificateMetadataPatch
type PrivateCertificatePrototype ¶
type PrivateCertificatePrototype struct {
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 name of the certificate template.
CertificateTemplate *string `json:"certificate_template" validate:"required"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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 certificate signing request.
Csr *string `json:"csr,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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_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 *string `json:"ttl,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,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"`
}
PrivateCertificatePrototype : PrivateCertificatePrototype struct This model "extends" SecretPrototype
type PrivateCertificateVersion ¶
type PrivateCertificateVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date" validate:"required"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number" validate:"required"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity" validate:"required"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate" validate:"required"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key" validate:"required"`
// 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"`
}
PrivateCertificateVersion : Your private certificate version. This model "extends" SecretVersion
type PrivateCertificateVersionActionRevoke ¶
type PrivateCertificateVersionActionRevoke struct {
// The type of secret version action.
ActionType *string `json:"action_type" validate:"required"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
}
PrivateCertificateVersionActionRevoke : The response body to specify the properties of the action to revoke the private certificate. This model "extends" VersionAction
type PrivateCertificateVersionActionRevokePrototype ¶
type PrivateCertificateVersionActionRevokePrototype struct {
// The type of secret version action.
ActionType *string `json:"action_type" validate:"required"`
}
PrivateCertificateVersionActionRevokePrototype : The request body to specify the properties of the action to revoke the private certificate. This model "extends" SecretVersionActionPrototype
type PrivateCertificateVersionMetadata ¶
type PrivateCertificateVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date" validate:"required"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number" validate:"required"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity" validate:"required"`
}
PrivateCertificateVersionMetadata : Properties of the version metadata of your private certificate. This model "extends" SecretVersionMetadata
type PrivateCertificateVersionPrototype ¶
type PrivateCertificateVersionPrototype struct {
// 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 certificate signing request.
Csr *string `json:"csr,omitempty"`
}
PrivateCertificateVersionPrototype : PrivateCertificateVersionPrototype struct This model "extends" SecretVersionPrototype
type PublicCertificate ¶
type PublicCertificate struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
// certificate.
SigningAlgorithm *string `json:"signing_algorithm,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The Common Name (CN) represents the server name protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// Issuance information that is associated with your certificate.
IssuanceInfo *CertificateIssuanceInfo `json:"issuance_info,omitempty"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,omitempty"`
// The identifier for the cryptographic algorithm that is 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. Allowed values: `RSA2048`, `RSA4096`, `ECDSA256`, and `ECDSA384`.
KeyAlgorithm *string `json:"key_algorithm" validate:"required"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation" validate:"required"`
// Indicates whether the issued certificate is bundled with intermediate certificates.
BundleCerts *bool `json:"bundle_certs,omitempty"`
// The name of the certificate authority configuration.
Ca *string `json:"ca,omitempty"`
// The name of the DNS provider configuration.
Dns *string `json:"dns,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,omitempty"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
}
PublicCertificate : Your public certificate. This model "extends" Secret
type PublicCertificateActionValidateManualDNS ¶
type PublicCertificateActionValidateManualDNS struct {
// The type of secret action.
ActionType *string `json:"action_type" validate:"required"`
}
PublicCertificateActionValidateManualDNS : The response body of the action to validate manual DNS challenges for the public certificate. This model "extends" SecretAction
type PublicCertificateActionValidateManualDNSPrototype ¶
type PublicCertificateActionValidateManualDNSPrototype struct {
// The type of secret action.
ActionType *string `json:"action_type" validate:"required"`
}
PublicCertificateActionValidateManualDNSPrototype : The request body to specify the properties of the action to validate manual DNS challenges for the public certificate. This model "extends" SecretActionPrototype
type PublicCertificateConfigurationCALetsEncrypt ¶
type PublicCertificateConfigurationCALetsEncrypt struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The configuration of the Let's Encrypt CA environment.
LetsEncryptEnvironment *string `json:"lets_encrypt_environment" validate:"required"`
// This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
// Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
LetsEncryptPreferredChain *string `json:"lets_encrypt_preferred_chain,omitempty"`
// The PEM-encoded private key of your Let's Encrypt account. The data must be formatted on a single line with embedded
// newline characters.
LetsEncryptPrivateKey *string `json:"lets_encrypt_private_key" validate:"required"`
}
PublicCertificateConfigurationCALetsEncrypt : Properties that describe a Let's Encrypt CA configuration. This model "extends" Configuration
type PublicCertificateConfigurationCALetsEncryptMetadata ¶
type PublicCertificateConfigurationCALetsEncryptMetadata struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The configuration of the Let's Encrypt CA environment.
LetsEncryptEnvironment *string `json:"lets_encrypt_environment" validate:"required"`
// This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
// Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
LetsEncryptPreferredChain *string `json:"lets_encrypt_preferred_chain,omitempty"`
}
PublicCertificateConfigurationCALetsEncryptMetadata : Your Let's Encrypt CA metadata properties. This model "extends" ConfigurationMetadata
type PublicCertificateConfigurationCALetsEncryptPatch ¶
type PublicCertificateConfigurationCALetsEncryptPatch struct {
// The configuration of the Let's Encrypt CA environment.
LetsEncryptEnvironment *string `json:"lets_encrypt_environment" validate:"required"`
// The PEM-encoded private key of your Let's Encrypt account. The data must be formatted on a single line with embedded
// newline characters.
LetsEncryptPrivateKey *string `json:"lets_encrypt_private_key,omitempty"`
// This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
// Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
LetsEncryptPreferredChain *string `json:"lets_encrypt_preferred_chain,omitempty"`
}
PublicCertificateConfigurationCALetsEncryptPatch : The configuration update of the Let's Encrypt Certificate Authority. This model "extends" ConfigurationPatch
func (*PublicCertificateConfigurationCALetsEncryptPatch) AsPatch ¶
func (publicCertificateConfigurationCALetsEncryptPatch *PublicCertificateConfigurationCALetsEncryptPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the PublicCertificateConfigurationCALetsEncryptPatch
type PublicCertificateConfigurationCALetsEncryptPrototype ¶
type PublicCertificateConfigurationCALetsEncryptPrototype struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// A human-readable unique name to assign to your configuration.
//
// To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
Name *string `json:"name" validate:"required"`
// The configuration of the Let's Encrypt CA environment.
LetsEncryptEnvironment *string `json:"lets_encrypt_environment" validate:"required"`
// The PEM-encoded private key of your Let's Encrypt account. The data must be formatted on a single line with embedded
// newline characters.
LetsEncryptPrivateKey *string `json:"lets_encrypt_private_key" validate:"required"`
// This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid
// Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.
LetsEncryptPreferredChain *string `json:"lets_encrypt_preferred_chain,omitempty"`
}
PublicCertificateConfigurationCALetsEncryptPrototype : The properties of the Let's Encrypt CA configuration. This model "extends" ConfigurationPrototype
type PublicCertificateConfigurationDNSClassicInfrastructure ¶
type PublicCertificateConfigurationDNSClassicInfrastructure struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// 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"`
}
PublicCertificateConfigurationDNSClassicInfrastructure : Properties that describe a Classic Infrastructure DNS configuration. This model "extends" Configuration
type PublicCertificateConfigurationDNSClassicInfrastructureMetadata ¶
type PublicCertificateConfigurationDNSClassicInfrastructureMetadata struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}
PublicCertificateConfigurationDNSClassicInfrastructureMetadata : Your Classic Infrastructure DNS metadata properties. This model "extends" ConfigurationMetadata
type PublicCertificateConfigurationDNSClassicInfrastructurePatch ¶
type PublicCertificateConfigurationDNSClassicInfrastructurePatch 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,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"`
}
PublicCertificateConfigurationDNSClassicInfrastructurePatch : Properties that describe the configuration update of an IBM Cloud classic infrastructure (SoftLayer). This model "extends" ConfigurationPatch
func (*PublicCertificateConfigurationDNSClassicInfrastructurePatch) AsPatch ¶
func (publicCertificateConfigurationDNSClassicInfrastructurePatch *PublicCertificateConfigurationDNSClassicInfrastructurePatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the PublicCertificateConfigurationDNSClassicInfrastructurePatch
type PublicCertificateConfigurationDNSClassicInfrastructurePrototype ¶
type PublicCertificateConfigurationDNSClassicInfrastructurePrototype struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// A human-readable unique name to assign to your configuration.
//
// To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
Name *string `json:"name" validate:"required"`
// 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"`
}
PublicCertificateConfigurationDNSClassicInfrastructurePrototype : PublicCertificateConfigurationDNSClassicInfrastructurePrototype struct This model "extends" ConfigurationPrototype
type PublicCertificateConfigurationDNSCloudInternetServices ¶
type PublicCertificateConfigurationDNSCloudInternetServices struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
//
// To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
// key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records you
// need to assign the Manager role.
//
// If you want to manage specific domains, you can assign the Manager role for this specific domain. 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.
//
// If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance with
// service-to-service authorization.
//
// For more information, see the
// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
CloudInternetServicesApikey *string `json:"cloud_internet_services_apikey,omitempty"`
// A CRN that uniquely identifies an IBM Cloud resource.
CloudInternetServicesCrn *string `json:"cloud_internet_services_crn" validate:"required"`
}
PublicCertificateConfigurationDNSCloudInternetServices : Properties that describe a Cloud Internet Services DNS configuration. This model "extends" Configuration
type PublicCertificateConfigurationDNSCloudInternetServicesMetadata ¶
type PublicCertificateConfigurationDNSCloudInternetServicesMetadata struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// The unique name of your configuration.
Name *string `json:"name" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}
PublicCertificateConfigurationDNSCloudInternetServicesMetadata : Your Cloud Internet Services DNS metadata properties. This model "extends" ConfigurationMetadata
type PublicCertificateConfigurationDNSCloudInternetServicesPatch ¶
type PublicCertificateConfigurationDNSCloudInternetServicesPatch struct {
// An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
//
// To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
// key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records you
// need to assign the Manager role.
//
// If you want to manage specific domains, you can assign the Manager role for this specific domain. 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.
//
// If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance with
// service-to-service authorization.
//
// For more information, see the
// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
CloudInternetServicesApikey *string `json:"cloud_internet_services_apikey" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
CloudInternetServicesCrn *string `json:"cloud_internet_services_crn,omitempty"`
}
PublicCertificateConfigurationDNSCloudInternetServicesPatch : The configuration update of the Cloud Internet Services DNS. This model "extends" ConfigurationPatch
func (*PublicCertificateConfigurationDNSCloudInternetServicesPatch) AsPatch ¶
func (publicCertificateConfigurationDNSCloudInternetServicesPatch *PublicCertificateConfigurationDNSCloudInternetServicesPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the PublicCertificateConfigurationDNSCloudInternetServicesPatch
type PublicCertificateConfigurationDNSCloudInternetServicesPrototype ¶
type PublicCertificateConfigurationDNSCloudInternetServicesPrototype struct {
// The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt,
// public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services,
// private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
ConfigType *string `json:"config_type" validate:"required"`
// A human-readable unique name to assign to your configuration.
//
// To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.
Name *string `json:"name" validate:"required"`
// An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.
//
// To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API
// key must be assigned the Reader service role on Internet Services (`internet-svcs`). In order to add DNS records you
// need to assign the Manager role.
//
// If you want to manage specific domains, you can assign the Manager role for this specific domain. 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.
//
// If an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance with
// service-to-service authorization.
//
// For more information, see the
// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).
CloudInternetServicesApikey *string `json:"cloud_internet_services_apikey,omitempty"`
// A CRN that uniquely identifies an IBM Cloud resource.
CloudInternetServicesCrn *string `json:"cloud_internet_services_crn" validate:"required"`
}
PublicCertificateConfigurationDNSCloudInternetServicesPrototype : Specify the properties for Cloud Internet Services DNS configuration. This model "extends" ConfigurationPrototype
type PublicCertificateMetadata ¶
type PublicCertificateMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
// certificate.
SigningAlgorithm *string `json:"signing_algorithm,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The Common Name (CN) represents the server name protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// Issuance information that is associated with your certificate.
IssuanceInfo *CertificateIssuanceInfo `json:"issuance_info,omitempty"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,omitempty"`
// The identifier for the cryptographic algorithm that is 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. Allowed values: `RSA2048`, `RSA4096`, `ECDSA256`, and `ECDSA384`.
KeyAlgorithm *string `json:"key_algorithm" validate:"required"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation" validate:"required"`
// Indicates whether the issued certificate is bundled with intermediate certificates.
BundleCerts *bool `json:"bundle_certs,omitempty"`
// The name of the certificate authority configuration.
Ca *string `json:"ca,omitempty"`
// The name of the DNS provider configuration.
Dns *string `json:"dns,omitempty"`
}
PublicCertificateMetadata : Properties of the metadata of your public certificate. This model "extends" SecretMetadata
type PublicCertificateMetadataPatch ¶
type PublicCertificateMetadataPatch struct {
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
}
PublicCertificateMetadataPatch : PublicCertificateMetadataPatch struct This model "extends" SecretMetadataPatch
func (*PublicCertificateMetadataPatch) AsPatch ¶
func (publicCertificateMetadataPatch *PublicCertificateMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the PublicCertificateMetadataPatch
type PublicCertificatePrototype ¶
type PublicCertificatePrototype struct {
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 Common Name (CN) represents the server name protected by the SSL certificate.
CommonName *string `json:"common_name" validate:"required"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The identifier for the cryptographic algorithm that is 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. Allowed values: `RSA2048`, `RSA4096`, `ECDSA256`, and `ECDSA384`.
KeyAlgorithm *string `json:"key_algorithm,omitempty"`
// The name of the certificate authority configuration.
Ca *string `json:"ca" validate:"required"`
// The name of the DNS provider configuration.
Dns *string `json:"dns" validate:"required"`
// This field indicates 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"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,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"`
}
PublicCertificatePrototype : PublicCertificatePrototype struct This model "extends" SecretPrototype
type PublicCertificateRotationObject ¶
type PublicCertificateRotationObject struct {
// This field indicates whether Secrets Manager rotates the private key for your public certificate automatically.
//
// The default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated
// certificate.
RotateKeys *bool `json:"rotate_keys,omitempty"`
}
PublicCertificateRotationObject : Defines the rotation object that is used to manually rotate public certificates.
type PublicCertificateRotationPolicy ¶
type PublicCertificateRotationPolicy struct {
// This field indicates whether Secrets Manager rotates your secret automatically.
//
// The default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined
// interval.
AutoRotate *bool `json:"auto_rotate" validate:"required"`
// This field indicates whether Secrets Manager rotates the private key for your public certificate automatically.
//
// The default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated
// certificate.
RotateKeys *bool `json:"rotate_keys" validate:"required"`
}
PublicCertificateRotationPolicy : This field indicates whether Secrets Manager rotates your secrets automatically.
For public certificates, if `auto_rotate` is set to `true`, the service reorders your certificate for 31 days, before it expires. This model "extends" RotationPolicy
type PublicCertificateVersion ¶
type PublicCertificateVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,omitempty"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
}
PublicCertificateVersion : Versions of your public certificate. This model "extends" SecretVersion
type PublicCertificateVersionMetadata ¶
type PublicCertificateVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity,omitempty"`
}
PublicCertificateVersionMetadata : Properties of the version metadata of your public certificate. This model "extends" SecretVersionMetadata
type PublicCertificateVersionPrototype ¶
type PublicCertificateVersionPrototype struct {
// Defines the rotation object that is used to manually rotate public certificates.
Rotation *PublicCertificateRotationObject `json:"rotation" 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"`
}
PublicCertificateVersionPrototype : PublicCertificateVersionPrototype struct This model "extends" SecretVersionPrototype
type RotationPolicy ¶
type RotationPolicy struct {
// This field indicates whether Secrets Manager rotates your secret automatically.
//
// The default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined
// interval.
AutoRotate *bool `json:"auto_rotate,omitempty"`
// 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"`
// This field indicates whether Secrets Manager rotates the private key for your public certificate automatically.
//
// The default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated
// certificate.
RotateKeys *bool `json:"rotate_keys,omitempty"`
}
RotationPolicy : This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types: username_password, private_cert, public_cert, iam_credentials. Models which "extend" this model: - CommonRotationPolicy - PublicCertificateRotationPolicy
type RotationPolicyIntf ¶
type RotationPolicyIntf interface {
// contains filtered or unexported methods
}
type Secret ¶
type Secret struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by,omitempty"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn,omitempty"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type,omitempty"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The secret data that is assigned to an `arbitrary` secret.
Payload *string `json:"payload,omitempty"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
// Access Groups that you can use for an `iam_credentials` secret.
//
// Up to 10 Access Groups can be used for each secret.
AccessGroups []string `json:"access_groups,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 it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to
// `false`, the service ID was generated by Secrets Manager.
ServiceIdIsStatic *bool `json:"service_id_is_static,omitempty"`
// (IAM credentials) This parameter indicates whether to reuse the service ID and API key for future read operations.
//
// If it is set to `true`, the service reuses the current credentials. If it is 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"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// The API key that is generated for this secret.
//
// After the secret reaches the end of its lease, the API key is deleted automatically. See the `time-to-live` field to
// understand the duration of the lease. 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 identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
// certificate.
SigningAlgorithm *string `json:"signing_algorithm,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The Common Name (CN) represents the server name protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// Indicates whether the certificate was imported with an associated intermediate certificate.
IntermediateIncluded *bool `json:"intermediate_included,omitempty"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,omitempty"`
// The identifier for the cryptographic algorithm used to generate the public key that is associated with the
// certificate.
KeyAlgorithm *string `json:"key_algorithm,omitempty"`
// Indicates whether the certificate was imported with an associated private key.
PrivateKeyIncluded *bool `json:"private_key_included,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,omitempty"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
// The payload data of a key-value secret.
Data map[string]interface{} `json:"data,omitempty"`
// The intermediate certificate authority that signed this certificate.
CertificateAuthority *string `json:"certificate_authority,omitempty"`
// The name of the certificate template.
CertificateTemplate *string `json:"certificate_template,omitempty"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,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 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"`
// Issuance information that is associated with your certificate.
IssuanceInfo *CertificateIssuanceInfo `json:"issuance_info,omitempty"`
// Indicates whether the issued certificate is bundled with intermediate certificates.
BundleCerts *bool `json:"bundle_certs,omitempty"`
// The name of the certificate authority configuration.
Ca *string `json:"ca,omitempty"`
// The name of the DNS provider configuration.
Dns *string `json:"dns,omitempty"`
// The properties of the resource key that was created for this source service instance.
SourceService *ServiceCredentialsSecretSourceServiceRO `json:"source_service,omitempty"`
// The properties of the service credentials secret payload.
Credentials *ServiceCredentialsSecretCredentials `json:"credentials,omitempty"`
// Policy for auto-generated passwords.
PasswordGenerationPolicy *PasswordGenerationPolicyRO `json:"password_generation_policy,omitempty"`
// The username that is assigned to an `username_password` secret.
Username *string `json:"username,omitempty"`
// The password that is assigned to an `username_password` secret.
Password *string `json:"password,omitempty"`
}
Secret : Your secret. Models which "extend" this model: - ArbitrarySecret - IAMCredentialsSecret - ImportedCertificate - KVSecret - PrivateCertificate - PublicCertificate - ServiceCredentialsSecret - UsernamePasswordSecret
type SecretAction ¶
type SecretAction struct {
// The type of secret action.
ActionType *string `json:"action_type,omitempty"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
}
SecretAction : The response body to specify the properties of the action to create a secret. Models which "extend" this model: - PublicCertificateActionValidateManualDNS - PrivateCertificateActionRevoke
type SecretActionIntf ¶
type SecretActionIntf interface {
// contains filtered or unexported methods
}
type SecretActionPrototype ¶
type SecretActionPrototype struct {
// The type of secret action.
ActionType *string `json:"action_type,omitempty"`
}
SecretActionPrototype : The request body to specify the properties for your secret action. Models which "extend" this model: - PrivateCertificateActionRevokePrototype - PublicCertificateActionValidateManualDNSPrototype
type SecretActionPrototypeIntf ¶
type SecretActionPrototypeIntf interface {
// contains filtered or unexported methods
}
type SecretGroup ¶
type SecretGroup struct {
// A v4 UUID identifier, or `default` secret group.
ID *string `json:"id" validate:"required"`
// The name of your existing 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" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}
SecretGroup : Properties that describe a secret group.
type SecretGroupCollection ¶
type SecretGroupCollection struct {
// A collection of secret groups.
SecretGroups []SecretGroup `json:"secret_groups" validate:"required"`
// The total number of resources in a collection.
TotalCount *int64 `json:"total_count" validate:"required"`
}
SecretGroupCollection : Properties that describe a collection of secret groups.
type SecretGroupPatch ¶
type SecretGroupPatch struct {
// The name of 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"`
}
SecretGroupPatch : Update the name or description of your secret group.
func (*SecretGroupPatch) AsPatch ¶
func (secretGroupPatch *SecretGroupPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the SecretGroupPatch
type SecretIntf ¶
type SecretIntf interface {
// contains filtered or unexported methods
}
type SecretLock ¶
type SecretLock 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"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// A v4 UUID identifier.
SecretVersionID *string `json:"secret_version_id" validate:"required"`
// A human-readable alias that describes the secret version. 'Current' is used for version `n` and 'previous' is used
// for version `n-1`.
SecretVersionAlias *string `json:"secret_version_alias" validate:"required"`
}
SecretLock : SecretLock struct
type SecretLockPrototype ¶
type SecretLockPrototype 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"`
}
SecretLockPrototype : SecretLockPrototype struct
type SecretLocks ¶
type SecretLocks struct {
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type,omitempty"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// A collection of locks that are attached to a secret.
Versions []SecretVersionLocks `json:"versions" validate:"required"`
}
SecretLocks : Create locks response body containing a collection of locks that are attached to a secret.
type SecretLocksPager ¶
type SecretLocksPager struct {
// contains filtered or unexported fields
}
SecretLocksPager can be used to simplify the use of the "ListSecretLocks" method.
func (*SecretLocksPager) GetAll ¶
func (pager *SecretLocksPager) GetAll() (allItems []SecretLock, err error)
GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.
func (*SecretLocksPager) GetAllWithContext ¶
func (pager *SecretLocksPager) GetAllWithContext(ctx context.Context) (allItems []SecretLock, err error)
GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.
func (*SecretLocksPager) GetNext ¶
func (pager *SecretLocksPager) GetNext() (page []SecretLock, err error)
GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.
func (*SecretLocksPager) GetNextWithContext ¶
func (pager *SecretLocksPager) GetNextWithContext(ctx context.Context) (page []SecretLock, err error)
GetNextWithContext returns the next page of results using the specified Context.
func (*SecretLocksPager) HasNext ¶
func (pager *SecretLocksPager) HasNext() bool
HasNext returns true if there are potentially more results to be retrieved.
type SecretLocksPaginatedCollection ¶
type SecretLocksPaginatedCollection struct {
// The total number of resources in a collection.
TotalCount *int64 `json:"total_count" validate:"required"`
// The number of items that are retrieved in a collection.
Limit *int64 `json:"limit" validate:"required"`
// The number of items that are skipped in a collection.
Offset *int64 `json:"offset" validate:"required"`
// A URL that points to the first page in a collection.
First *PaginatedCollectionFirst `json:"first" validate:"required"`
// A URL that points to the next page in a collection.
Next *PaginatedCollectionNext `json:"next,omitempty"`
// A URL that points to the previous page in a collection.
Previous *PaginatedCollectionPrevious `json:"previous,omitempty"`
// A URL that points to the last page in a collection.
Last *PaginatedCollectionLast `json:"last" validate:"required"`
// A collection of secret locks.
Locks []SecretLock `json:"locks" validate:"required"`
}
SecretLocksPaginatedCollection : Properties that describe a paginated collection of your secret locks.
func (*SecretLocksPaginatedCollection) GetNextOffset ¶
func (resp *SecretLocksPaginatedCollection) GetNextOffset() (*int64, error)
Retrieve the value to be passed to a request to access the next page of results
type SecretMetadata ¶
type SecretMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by,omitempty"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn,omitempty"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type,omitempty"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
// Access Groups that you can use for an `iam_credentials` secret.
//
// Up to 10 Access Groups can be used for each secret.
AccessGroups []string `json:"access_groups,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 it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to
// `false`, the service ID was generated by Secrets Manager.
ServiceIdIsStatic *bool `json:"service_id_is_static,omitempty"`
// (IAM credentials) This parameter indicates whether to reuse the service ID and API key for future read operations.
//
// If it is set to `true`, the service reuses the current credentials. If it is 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"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// The identifier for the cryptographic algorithm that is used by the issuing certificate authority to sign a
// certificate.
SigningAlgorithm *string `json:"signing_algorithm,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
AltNames []string `json:"alt_names,omitempty"`
// The Common Name (CN) represents the server name protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// Indicates whether the certificate was imported with an associated intermediate certificate.
IntermediateIncluded *bool `json:"intermediate_included,omitempty"`
// The distinguished name that identifies the entity that signed and issued the certificate.
Issuer *string `json:"issuer,omitempty"`
// The identifier for the cryptographic algorithm used to generate the public key that is associated with the
// certificate.
KeyAlgorithm *string `json:"key_algorithm,omitempty"`
// Indicates whether the certificate was imported with an associated private key.
PrivateKeyIncluded *bool `json:"private_key_included,omitempty"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity,omitempty"`
// The intermediate certificate authority that signed this certificate.
CertificateAuthority *string `json:"certificate_authority,omitempty"`
// The name of the certificate template.
CertificateTemplate *string `json:"certificate_template,omitempty"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
// The date and time that the certificate was revoked. The date format follows `RFC 3339`.
RevocationTimeRfc3339 *strfmt.DateTime `json:"revocation_time_rfc3339,omitempty"`
// Issuance information that is associated with your certificate.
IssuanceInfo *CertificateIssuanceInfo `json:"issuance_info,omitempty"`
// Indicates whether the issued certificate is bundled with intermediate certificates.
BundleCerts *bool `json:"bundle_certs,omitempty"`
// The name of the certificate authority configuration.
Ca *string `json:"ca,omitempty"`
// The name of the DNS provider configuration.
Dns *string `json:"dns,omitempty"`
// The properties of the resource key that was created for this source service instance.
SourceService *ServiceCredentialsSecretSourceServiceRO `json:"source_service,omitempty"`
// Policy for auto-generated passwords.
PasswordGenerationPolicy *PasswordGenerationPolicyRO `json:"password_generation_policy,omitempty"`
}
SecretMetadata : Properties of your secret metadata. Models which "extend" this model: - ArbitrarySecretMetadata - IAMCredentialsSecretMetadata - ImportedCertificateMetadata - KVSecretMetadata - PrivateCertificateMetadata - PublicCertificateMetadata - ServiceCredentialsSecretMetadata - UsernamePasswordSecretMetadata
type SecretMetadataIntf ¶
type SecretMetadataIntf interface {
// contains filtered or unexported methods
}
type SecretMetadataPaginatedCollection ¶
type SecretMetadataPaginatedCollection struct {
// The total number of resources in a collection.
TotalCount *int64 `json:"total_count" validate:"required"`
// The number of items that are retrieved in a collection.
Limit *int64 `json:"limit" validate:"required"`
// The number of items that are skipped in a collection.
Offset *int64 `json:"offset" validate:"required"`
// A URL that points to the first page in a collection.
First *PaginatedCollectionFirst `json:"first" validate:"required"`
// A URL that points to the next page in a collection.
Next *PaginatedCollectionNext `json:"next,omitempty"`
// A URL that points to the previous page in a collection.
Previous *PaginatedCollectionPrevious `json:"previous,omitempty"`
// A URL that points to the last page in a collection.
Last *PaginatedCollectionLast `json:"last" validate:"required"`
// A collection of secret metadata.
Secrets []SecretMetadataIntf `json:"secrets" validate:"required"`
}
SecretMetadataPaginatedCollection : Properties that describe a paginated collection of your secret metadata.
func (*SecretMetadataPaginatedCollection) GetNextOffset ¶
func (resp *SecretMetadataPaginatedCollection) GetNextOffset() (*int64, error)
Retrieve the value to be passed to a request to access the next page of results
type SecretMetadataPatch ¶
type SecretMetadataPatch struct {
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// Policy patch for auto-generated passwords. Policy properties that are included in the patch are updated.
// Properties that are not included in the patch remain unchanged.
PasswordGenerationPolicy *PasswordGenerationPolicyPatch `json:"password_generation_policy,omitempty"`
}
SecretMetadataPatch : Update your secret metadata. Models which "extend" this model: - ArbitrarySecretMetadataPatch - IAMCredentialsSecretMetadataPatch - ImportedCertificateMetadataPatch - KVSecretMetadataPatch - PrivateCertificateMetadataPatch - PublicCertificateMetadataPatch - ServiceCredentialsSecretMetadataPatch - UsernamePasswordSecretMetadataPatch
func (*SecretMetadataPatch) AsPatch ¶
func (secretMetadataPatch *SecretMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the SecretMetadataPatch
type SecretMetadataPatchIntf ¶
type SecretMetadataPatchIntf interface {
// contains filtered or unexported methods
}
type SecretPrototype ¶
type SecretPrototype struct {
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type,omitempty"`
// The secret data that is assigned to an `arbitrary` secret.
Payload *string `json:"payload,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 credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
// Access Groups that you can use for an `iam_credentials` secret.
//
// Up to 10 Access Groups can be used for each secret.
AccessGroups []string `json:"access_groups,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"`
// (IAM credentials) This parameter indicates whether to reuse the service ID and API key for future read operations.
//
// If it is set to `true`, the service reuses the current credentials. If it is 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"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,omitempty"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
// The payload data of a key-value secret.
Data map[string]interface{} `json:"data,omitempty"`
// The name of the certificate template.
CertificateTemplate *string `json:"certificate_template,omitempty"`
// The Common Name (CN) represents the server name that is protected by the SSL certificate.
CommonName *string `json:"common_name,omitempty"`
// With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL
// certificate.
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 certificate signing request.
Csr *string `json:"csr,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"`
// This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).
//
// If the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be
// useful if the common name is a human-readable identifier, instead of a hostname or an email address.
ExcludeCnFromSans *bool `json:"exclude_cn_from_sans,omitempty"`
// The identifier for the cryptographic algorithm that is 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. Allowed values: `RSA2048`, `RSA4096`, `ECDSA256`, and `ECDSA384`.
KeyAlgorithm *string `json:"key_algorithm,omitempty"`
// The name of the certificate authority configuration.
Ca *string `json:"ca,omitempty"`
// The name of the DNS provider configuration.
Dns *string `json:"dns,omitempty"`
// This field indicates 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 properties that are required to create the service credentials for the specified source service instance.
SourceService *ServiceCredentialsSecretSourceService `json:"source_service,omitempty"`
// The username that is assigned to an `username_password` secret.
Username *string `json:"username,omitempty"`
// The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager
// generates a new random password for your secret.
Password *string `json:"password,omitempty"`
// Policy for auto-generated passwords.
PasswordGenerationPolicy *PasswordGenerationPolicy `json:"password_generation_policy,omitempty"`
}
SecretPrototype : Specify the properties for your secret. Models which "extend" this model: - ArbitrarySecretPrototype - IAMCredentialsSecretPrototype - ImportedCertificatePrototype - KVSecretPrototype - PrivateCertificatePrototype - PublicCertificatePrototype - ServiceCredentialsSecretPrototype - UsernamePasswordSecretPrototype
type SecretPrototypeIntf ¶
type SecretPrototypeIntf interface {
// contains filtered or unexported methods
}
type SecretVersion ¶
type SecretVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by,omitempty"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id,omitempty"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available,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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The secret data that is assigned to an `arbitrary` secret.
Payload *string `json:"payload,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"`
// The API key that is generated for this secret.
//
// After the secret reaches the end of its lease, the API key is deleted automatically. See the `time-to-live` field to
// understand the duration of the lease. 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 unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,omitempty"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
// The payload data of a key-value secret.
Data map[string]interface{} `json:"data,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 source service resource key data of the generated service credentials.
ResourceKey *ServiceCredentialsResourceKey `json:"resource_key,omitempty"`
// The properties of the service credentials secret payload.
Credentials *ServiceCredentialsSecretCredentials `json:"credentials,omitempty"`
// The username that is assigned to an `username_password` secret.
Username *string `json:"username,omitempty"`
// The password that is assigned to an `username_password` secret.
Password *string `json:"password,omitempty"`
}
SecretVersion : Your secret version. Models which "extend" this model: - ArbitrarySecretVersion - IAMCredentialsSecretVersion - ImportedCertificateVersion - KVSecretVersion - PrivateCertificateVersion - PublicCertificateVersion - ServiceCredentialsSecretVersion - UsernamePasswordSecretVersion
type SecretVersionActionPrototype ¶
type SecretVersionActionPrototype struct {
// The type of secret version action.
ActionType *string `json:"action_type,omitempty"`
}
SecretVersionActionPrototype : The request body to specify the properties of the action to create a secret version. Models which "extend" this model: - PrivateCertificateVersionActionRevokePrototype
type SecretVersionActionPrototypeIntf ¶
type SecretVersionActionPrototypeIntf interface {
// contains filtered or unexported methods
}
type SecretVersionIntf ¶
type SecretVersionIntf interface {
// contains filtered or unexported methods
}
type SecretVersionLocks ¶
type SecretVersionLocks struct {
// A v4 UUID identifier.
VersionID *string `json:"version_id" validate:"required"`
// A human-readable alias that describes the secret version. 'Current' is used for version `n` and 'previous' is used
// for version `n-1`.
VersionAlias *string `json:"version_alias" validate:"required"`
// The names of all locks that are associated with this secret version.
Locks []string `json:"locks" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available,omitempty"`
}
SecretVersionLocks : SecretVersionLocks struct
type SecretVersionLocksPager ¶
type SecretVersionLocksPager struct {
// contains filtered or unexported fields
}
SecretVersionLocksPager can be used to simplify the use of the "ListSecretVersionLocks" method.
func (*SecretVersionLocksPager) GetAll ¶
func (pager *SecretVersionLocksPager) GetAll() (allItems []SecretLock, err error)
GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.
func (*SecretVersionLocksPager) GetAllWithContext ¶
func (pager *SecretVersionLocksPager) GetAllWithContext(ctx context.Context) (allItems []SecretLock, err error)
GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.
func (*SecretVersionLocksPager) GetNext ¶
func (pager *SecretVersionLocksPager) GetNext() (page []SecretLock, err error)
GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.
func (*SecretVersionLocksPager) GetNextWithContext ¶
func (pager *SecretVersionLocksPager) GetNextWithContext(ctx context.Context) (page []SecretLock, err error)
GetNextWithContext returns the next page of results using the specified Context.
func (*SecretVersionLocksPager) HasNext ¶
func (pager *SecretVersionLocksPager) HasNext() bool
HasNext returns true if there are potentially more results to be retrieved.
type SecretVersionLocksPaginatedCollection ¶
type SecretVersionLocksPaginatedCollection struct {
// The total number of resources in a collection.
TotalCount *int64 `json:"total_count" validate:"required"`
// The number of items that are retrieved in a collection.
Limit *int64 `json:"limit" validate:"required"`
// The number of items that are skipped in a collection.
Offset *int64 `json:"offset" validate:"required"`
// A URL that points to the first page in a collection.
First *PaginatedCollectionFirst `json:"first" validate:"required"`
// A URL that points to the next page in a collection.
Next *PaginatedCollectionNext `json:"next,omitempty"`
// A URL that points to the previous page in a collection.
Previous *PaginatedCollectionPrevious `json:"previous,omitempty"`
// A URL that points to the last page in a collection.
Last *PaginatedCollectionLast `json:"last" validate:"required"`
// A collection of secret version locks.
Locks []SecretLock `json:"locks" validate:"required"`
}
SecretVersionLocksPaginatedCollection : Properties that describe a paginated collection of your secret version locks.
func (*SecretVersionLocksPaginatedCollection) GetNextOffset ¶
func (resp *SecretVersionLocksPaginatedCollection) GetNextOffset() (*int64, error)
Retrieve the value to be passed to a request to access the next page of results
type SecretVersionMetadata ¶
type SecretVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by,omitempty"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id,omitempty"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available,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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,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"`
// The unique serial number that was assigned to a certificate by the issuing certificate authority.
SerialNumber *string `json:"serial_number,omitempty"`
// The date and time that the certificate validity period begins and ends.
Validity *CertificateValidity `json:"validity,omitempty"`
// The source service resource key data of the generated service credentials.
ResourceKey *ServiceCredentialsResourceKey `json:"resource_key,omitempty"`
}
SecretVersionMetadata : Properties of the version metadata of your secret. Models which "extend" this model: - ArbitrarySecretVersionMetadata - IAMCredentialsSecretVersionMetadata - ImportedCertificateVersionMetadata - KVSecretVersionMetadata - PrivateCertificateVersionMetadata - PublicCertificateVersionMetadata - ServiceCredentialsSecretVersionMetadata - UsernamePasswordSecretVersionMetadata
type SecretVersionMetadataCollection ¶
type SecretVersionMetadataCollection struct {
// A collection of secret version metadata.
Versions []SecretVersionMetadataIntf `json:"versions" validate:"required"`
// The total number of resources in a collection.
TotalCount *int64 `json:"total_count" validate:"required"`
}
SecretVersionMetadataCollection : Properties that describe a collection of your secret version metadata.
type SecretVersionMetadataIntf ¶
type SecretVersionMetadataIntf interface {
// contains filtered or unexported methods
}
type SecretVersionMetadataPatch ¶
type SecretVersionMetadataPatch struct {
// The secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}
SecretVersionMetadataPatch : Update your secret version metadata.
func (*SecretVersionMetadataPatch) AsPatch ¶
func (secretVersionMetadataPatch *SecretVersionMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the SecretVersionMetadataPatch
type SecretVersionPrototype ¶
type SecretVersionPrototype struct {
// The secret data that is assigned to an `arbitrary` secret.
Payload *string `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"`
// A v4 UUID identifier, or `current` or `previous` secret version aliases.
RestoreFromVersion *string `json:"restore_from_version,omitempty"`
// Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline characters.
Certificate *string `json:"certificate,omitempty"`
// The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on
// a single line with embedded newline characters.
Intermediate *string `json:"intermediate,omitempty"`
// The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line
// with embedded newline characters.
PrivateKey *string `json:"private_key,omitempty"`
// The payload data of a key-value secret.
Data map[string]interface{} `json:"data,omitempty"`
// The certificate signing request.
Csr *string `json:"csr,omitempty"`
// Defines the rotation object that is used to manually rotate public certificates.
Rotation *PublicCertificateRotationObject `json:"rotation,omitempty"`
// The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager
// generates a new random password for your secret.
Password *string `json:"password,omitempty"`
}
SecretVersionPrototype : Specify the properties for your new secret version. Models which "extend" this model: - ArbitrarySecretVersionPrototype - IAMCredentialsSecretRestoreFromVersionPrototype - IAMCredentialsSecretVersionPrototype - ImportedCertificateVersionPrototype - KVSecretVersionPrototype - PrivateCertificateVersionPrototype - PublicCertificateVersionPrototype - ServiceCredentialsSecretVersionPrototype - UsernamePasswordSecretVersionPrototype
type SecretVersionPrototypeIntf ¶
type SecretVersionPrototypeIntf interface {
// contains filtered or unexported methods
}
type SecretsLocksPager ¶
type SecretsLocksPager struct {
// contains filtered or unexported fields
}
SecretsLocksPager can be used to simplify the use of the "ListSecretsLocks" method.
func (*SecretsLocksPager) GetAll ¶
func (pager *SecretsLocksPager) GetAll() (allItems []SecretLocks, err error)
GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.
func (*SecretsLocksPager) GetAllWithContext ¶
func (pager *SecretsLocksPager) GetAllWithContext(ctx context.Context) (allItems []SecretLocks, err error)
GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.
func (*SecretsLocksPager) GetNext ¶
func (pager *SecretsLocksPager) GetNext() (page []SecretLocks, err error)
GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.
func (*SecretsLocksPager) GetNextWithContext ¶
func (pager *SecretsLocksPager) GetNextWithContext(ctx context.Context) (page []SecretLocks, err error)
GetNextWithContext returns the next page of results using the specified Context.
func (*SecretsLocksPager) HasNext ¶
func (pager *SecretsLocksPager) HasNext() bool
HasNext returns true if there are potentially more results to be retrieved.
type SecretsLocksPaginatedCollection ¶
type SecretsLocksPaginatedCollection struct {
// The total number of resources in a collection.
TotalCount *int64 `json:"total_count" validate:"required"`
// The number of items that are retrieved in a collection.
Limit *int64 `json:"limit" validate:"required"`
// The number of items that are skipped in a collection.
Offset *int64 `json:"offset" validate:"required"`
// A URL that points to the first page in a collection.
First *PaginatedCollectionFirst `json:"first" validate:"required"`
// A URL that points to the next page in a collection.
Next *PaginatedCollectionNext `json:"next,omitempty"`
// A URL that points to the previous page in a collection.
Previous *PaginatedCollectionPrevious `json:"previous,omitempty"`
// A URL that points to the last page in a collection.
Last *PaginatedCollectionLast `json:"last" validate:"required"`
// A collection of secrets and their locks.
SecretsLocks []SecretLocks `json:"secrets_locks" validate:"required"`
}
SecretsLocksPaginatedCollection : Properties that describe a paginated collection of your secrets locks.
func (*SecretsLocksPaginatedCollection) GetNextOffset ¶
func (resp *SecretsLocksPaginatedCollection) GetNextOffset() (*int64, error)
Retrieve the value to be passed to a request to access the next page of results
type SecretsManagerV2 ¶
type SecretsManagerV2 struct {
Service *core.BaseService
}
SecretsManagerV2 : 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.
API Version: 2.0.0 See: https://cloud.ibm.com/docs/secrets-manager
func NewSecretsManagerV2 ¶
func NewSecretsManagerV2(options *SecretsManagerV2Options) (service *SecretsManagerV2, err error)
NewSecretsManagerV2 : constructs an instance of SecretsManagerV2 with passed in options.
func NewSecretsManagerV2UsingExternalConfig ¶
func NewSecretsManagerV2UsingExternalConfig(options *SecretsManagerV2Options) (secretsManager *SecretsManagerV2, err error)
NewSecretsManagerV2UsingExternalConfig : constructs an instance of SecretsManagerV2 with passed in options and external configuration.
func (*SecretsManagerV2) Clone ¶
func (secretsManager *SecretsManagerV2) Clone() *SecretsManagerV2
Clone makes a copy of "secretsManager" suitable for processing requests.
func (*SecretsManagerV2) CreateConfiguration ¶
func (secretsManager *SecretsManagerV2) CreateConfiguration(createConfigurationOptions *CreateConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
CreateConfiguration : Create a new configuration Add a configuration to the specified secret type.
Use this operation to define the configurations that are required to create public certificates (`public_cert`), private certificates (`private_cert`) and IAM Credentials secrets (`iam_credentials`).
You can add multiple configurations for your instance as follows:
- A single configuration for IAM Credentials. - Up to 10 CA configurations for public certificates. - Up to 10 DNS configurations for public certificates. - Up to 10 Root CA configurations for private certificates. - Up to 10 Intermediate CA configurations for private certificates. - Up to 10 Certificate Template configurations for private certificates.
func (*SecretsManagerV2) CreateConfigurationAction ¶
func (secretsManager *SecretsManagerV2) CreateConfigurationAction(createConfigurationActionOptions *CreateConfigurationActionOptions) (result ConfigurationActionIntf, response *core.DetailedResponse, err error)
CreateConfigurationAction : Create a configuration action Create a configuration action. This operation supports the following actions:
- `private_cert_configuration_action_sign_intermediate`: Sign an intermediate certificate authority. - `private_cert_configuration_action_sign_csr`: Sign a certificate signing request. - `private_cert_configuration_action_set_signed`: Set a signed intermediate certificate authority. - `private_cert_configuration_action_revoke_ca_certificate`: Revoke an internally signed intermediate certificate authority certificate. - `private_cert_configuration_action_rotate_crl`: Rotate the certificate revocation list (CRL) of an intermediate certificate authority.
func (*SecretsManagerV2) CreateConfigurationActionWithContext ¶
func (secretsManager *SecretsManagerV2) CreateConfigurationActionWithContext(ctx context.Context, createConfigurationActionOptions *CreateConfigurationActionOptions) (result ConfigurationActionIntf, response *core.DetailedResponse, err error)
CreateConfigurationActionWithContext is an alternate form of the CreateConfigurationAction method which supports a Context parameter
func (*SecretsManagerV2) CreateConfigurationWithContext ¶
func (secretsManager *SecretsManagerV2) CreateConfigurationWithContext(ctx context.Context, createConfigurationOptions *CreateConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
CreateConfigurationWithContext is an alternate form of the CreateConfiguration method which supports a Context parameter
func (*SecretsManagerV2) CreateNotificationsRegistration ¶
func (secretsManager *SecretsManagerV2) CreateNotificationsRegistration(createNotificationsRegistrationOptions *CreateNotificationsRegistrationOptions) (result *NotificationsRegistration, response *core.DetailedResponse, err error)
CreateNotificationsRegistration : Register with Event Notifications instance 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 (*SecretsManagerV2) CreateNotificationsRegistrationWithContext ¶
func (secretsManager *SecretsManagerV2) CreateNotificationsRegistrationWithContext(ctx context.Context, createNotificationsRegistrationOptions *CreateNotificationsRegistrationOptions) (result *NotificationsRegistration, response *core.DetailedResponse, err error)
CreateNotificationsRegistrationWithContext is an alternate form of the CreateNotificationsRegistration method which supports a Context parameter
func (*SecretsManagerV2) CreateSecret ¶
func (secretsManager *SecretsManagerV2) CreateSecret(createSecretOptions *CreateSecretOptions) (result SecretIntf, response *core.DetailedResponse, err error)
CreateSecret : Create a new secret Create a secret or import an existing value that you can use to access or authenticate to a protected resource.
Use this operation to either generate or import an existing secret, such as 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 (*SecretsManagerV2) CreateSecretAction ¶
func (secretsManager *SecretsManagerV2) CreateSecretAction(createSecretActionOptions *CreateSecretActionOptions) (result SecretActionIntf, response *core.DetailedResponse, err error)
CreateSecretAction : Create a secret action Create a secret action. This operation supports the following actions:.
func (*SecretsManagerV2) CreateSecretActionWithContext ¶
func (secretsManager *SecretsManagerV2) CreateSecretActionWithContext(ctx context.Context, createSecretActionOptions *CreateSecretActionOptions) (result SecretActionIntf, response *core.DetailedResponse, err error)
CreateSecretActionWithContext is an alternate form of the CreateSecretAction method which supports a Context parameter
func (*SecretsManagerV2) CreateSecretGroup ¶
func (secretsManager *SecretsManagerV2) CreateSecretGroup(createSecretGroupOptions *CreateSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
CreateSecretGroup : Create a new secret group Create a secret group that you can use to organize secrets and control who can access them.
A successful request returns the ID value of the secret group, along with other properties. To learn more about secret groups, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-groups).
func (*SecretsManagerV2) CreateSecretGroupWithContext ¶
func (secretsManager *SecretsManagerV2) CreateSecretGroupWithContext(ctx context.Context, createSecretGroupOptions *CreateSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
CreateSecretGroupWithContext is an alternate form of the CreateSecretGroup method which supports a Context parameter
func (*SecretsManagerV2) CreateSecretLocksBulk ¶
func (secretsManager *SecretsManagerV2) CreateSecretLocksBulk(createSecretLocksBulkOptions *CreateSecretLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
CreateSecretLocksBulk : Create secret locks 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 operation to clear any matching locks on a secret by using one of the following optional lock modes:
- `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the secret.\n - `remove_previous_and_delete`: Carries out the same function as `remove_previous`, but also permanently deletes the data of the previous secret version if it doesn't have any locks.
func (*SecretsManagerV2) CreateSecretLocksBulkWithContext ¶
func (secretsManager *SecretsManagerV2) CreateSecretLocksBulkWithContext(ctx context.Context, createSecretLocksBulkOptions *CreateSecretLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
CreateSecretLocksBulkWithContext is an alternate form of the CreateSecretLocksBulk method which supports a Context parameter
func (*SecretsManagerV2) CreateSecretVersion ¶
func (secretsManager *SecretsManagerV2) CreateSecretVersion(createSecretVersionOptions *CreateSecretVersionOptions) (result SecretVersionIntf, response *core.DetailedResponse, err error)
CreateSecretVersion : Create a new secret version Create a new secret version.
func (*SecretsManagerV2) CreateSecretVersionAction ¶
func (secretsManager *SecretsManagerV2) CreateSecretVersionAction(createSecretVersionActionOptions *CreateSecretVersionActionOptions) (result VersionActionIntf, response *core.DetailedResponse, err error)
CreateSecretVersionAction : Create a version action Create a secret version action. This operation supports the following actions:
- `private_cert_action_revoke_certificate`: Revoke a version of a private certificate.
func (*SecretsManagerV2) CreateSecretVersionActionWithContext ¶
func (secretsManager *SecretsManagerV2) CreateSecretVersionActionWithContext(ctx context.Context, createSecretVersionActionOptions *CreateSecretVersionActionOptions) (result VersionActionIntf, response *core.DetailedResponse, err error)
CreateSecretVersionActionWithContext is an alternate form of the CreateSecretVersionAction method which supports a Context parameter
func (*SecretsManagerV2) CreateSecretVersionLocksBulk ¶
func (secretsManager *SecretsManagerV2) CreateSecretVersionLocksBulk(createSecretVersionLocksBulkOptions *CreateSecretVersionLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
CreateSecretVersionLocksBulk : Create secret version locks 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 your secret, or replaces a lock of the same name if it already exists. Additionally, you can use this operation to clear any matching locks on a secret by using one of the following optional lock modes:
- `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the secret. - `remove_previous_and_delete`: Carries out the same function as `remove_previous`, but also permanently deletes the data of the previous secret version if it doesn't have any locks.
func (*SecretsManagerV2) CreateSecretVersionLocksBulkWithContext ¶
func (secretsManager *SecretsManagerV2) CreateSecretVersionLocksBulkWithContext(ctx context.Context, createSecretVersionLocksBulkOptions *CreateSecretVersionLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
CreateSecretVersionLocksBulkWithContext is an alternate form of the CreateSecretVersionLocksBulk method which supports a Context parameter
func (*SecretsManagerV2) CreateSecretVersionWithContext ¶
func (secretsManager *SecretsManagerV2) CreateSecretVersionWithContext(ctx context.Context, createSecretVersionOptions *CreateSecretVersionOptions) (result SecretVersionIntf, response *core.DetailedResponse, err error)
CreateSecretVersionWithContext is an alternate form of the CreateSecretVersion method which supports a Context parameter
func (*SecretsManagerV2) CreateSecretWithContext ¶
func (secretsManager *SecretsManagerV2) CreateSecretWithContext(ctx context.Context, createSecretOptions *CreateSecretOptions) (result SecretIntf, response *core.DetailedResponse, err error)
CreateSecretWithContext is an alternate form of the CreateSecret method which supports a Context parameter
func (*SecretsManagerV2) DeleteConfiguration ¶
func (secretsManager *SecretsManagerV2) DeleteConfiguration(deleteConfigurationOptions *DeleteConfigurationOptions) (response *core.DetailedResponse, err error)
DeleteConfiguration : Delete a configuration Delete a configuration by specifying its name.
func (*SecretsManagerV2) DeleteConfigurationWithContext ¶
func (secretsManager *SecretsManagerV2) DeleteConfigurationWithContext(ctx context.Context, deleteConfigurationOptions *DeleteConfigurationOptions) (response *core.DetailedResponse, err error)
DeleteConfigurationWithContext is an alternate form of the DeleteConfiguration method which supports a Context parameter
func (*SecretsManagerV2) DeleteNotificationsRegistration ¶
func (secretsManager *SecretsManagerV2) DeleteNotificationsRegistration(deleteNotificationsRegistrationOptions *DeleteNotificationsRegistrationOptions) (response *core.DetailedResponse, err error)
DeleteNotificationsRegistration : Unregister from Event Notifications instance Delete the registration between your Secrets Manager instance and Event Notifications.
A successful request removes your Secrets Manager instance as a source in Event Notifications.
func (*SecretsManagerV2) DeleteNotificationsRegistrationWithContext ¶
func (secretsManager *SecretsManagerV2) 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 (*SecretsManagerV2) DeleteSecret ¶
func (secretsManager *SecretsManagerV2) DeleteSecret(deleteSecretOptions *DeleteSecretOptions) (response *core.DetailedResponse, err error)
DeleteSecret : Delete a secret Delete a secret by specifying the ID of the secret.
func (*SecretsManagerV2) DeleteSecretGroup ¶
func (secretsManager *SecretsManagerV2) 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 (*SecretsManagerV2) DeleteSecretGroupWithContext ¶
func (secretsManager *SecretsManagerV2) 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 (*SecretsManagerV2) DeleteSecretLocksBulk ¶
func (secretsManager *SecretsManagerV2) DeleteSecretLocksBulk(deleteSecretLocksBulkOptions *DeleteSecretLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
DeleteSecretLocksBulk : Delete secret locks Delete all the locks or a subset of the locks that are associated with a version of a secret.
To delete only a subset of the locks, add a query param with a comma to separate the list of lock names:
Example: `?name=lock-example-1,lock-example-2`.
**Note:** A secret is considered unlocked and able to be deleted only after you remove all of its locks. To determine whether a secret contains locks, check the `locks_total` field that is returned as part of the metadata of your secret.
func (*SecretsManagerV2) DeleteSecretLocksBulkWithContext ¶
func (secretsManager *SecretsManagerV2) DeleteSecretLocksBulkWithContext(ctx context.Context, deleteSecretLocksBulkOptions *DeleteSecretLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
DeleteSecretLocksBulkWithContext is an alternate form of the DeleteSecretLocksBulk method which supports a Context parameter
func (*SecretsManagerV2) DeleteSecretVersionData ¶
func (secretsManager *SecretsManagerV2) DeleteSecretVersionData(deleteSecretVersionDataOptions *DeleteSecretVersionDataOptions) (response *core.DetailedResponse, err error)
DeleteSecretVersionData : Delete the data of a secret version Delete the data of a secret version by specifying the ID of the version.
This operation is available for secret type: iam_credentials current version.
func (*SecretsManagerV2) DeleteSecretVersionDataWithContext ¶
func (secretsManager *SecretsManagerV2) DeleteSecretVersionDataWithContext(ctx context.Context, deleteSecretVersionDataOptions *DeleteSecretVersionDataOptions) (response *core.DetailedResponse, err error)
DeleteSecretVersionDataWithContext is an alternate form of the DeleteSecretVersionData method which supports a Context parameter
func (*SecretsManagerV2) DeleteSecretVersionLocksBulk ¶
func (secretsManager *SecretsManagerV2) DeleteSecretVersionLocksBulk(deleteSecretVersionLocksBulkOptions *DeleteSecretVersionLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
DeleteSecretVersionLocksBulk : Delete locks on a secret version Delete all the locks or a subset of the locks that are associated with the specified version of a secret.
To delete only a subset of the locks, add a query param with a comma to separate the list of lock names:
Example: `?name=lock-example-1,lock-example-2`.
**Note:** A secret is considered unlocked and able to be deleted only after all of its locks are removed. To determine whether a secret contains locks, check the `locks_total` field that is returned as part of the metadata of your secret.
func (*SecretsManagerV2) DeleteSecretVersionLocksBulkWithContext ¶
func (secretsManager *SecretsManagerV2) DeleteSecretVersionLocksBulkWithContext(ctx context.Context, deleteSecretVersionLocksBulkOptions *DeleteSecretVersionLocksBulkOptions) (result *SecretLocks, response *core.DetailedResponse, err error)
DeleteSecretVersionLocksBulkWithContext is an alternate form of the DeleteSecretVersionLocksBulk method which supports a Context parameter
func (*SecretsManagerV2) DeleteSecretWithContext ¶
func (secretsManager *SecretsManagerV2) 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 (*SecretsManagerV2) DisableRetries ¶
func (secretsManager *SecretsManagerV2) DisableRetries()
DisableRetries disables automatic retries for requests invoked for this service instance.
func (*SecretsManagerV2) EnableRetries ¶
func (secretsManager *SecretsManagerV2) 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 (*SecretsManagerV2) GetConfiguration ¶
func (secretsManager *SecretsManagerV2) GetConfiguration(getConfigurationOptions *GetConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
GetConfiguration : Get a configuration Get a configuration by specifying its name.
A successful request returns the details of your configuration.
func (*SecretsManagerV2) GetConfigurationWithContext ¶
func (secretsManager *SecretsManagerV2) GetConfigurationWithContext(ctx context.Context, getConfigurationOptions *GetConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
GetConfigurationWithContext is an alternate form of the GetConfiguration method which supports a Context parameter
func (*SecretsManagerV2) GetEnableGzipCompression ¶
func (secretsManager *SecretsManagerV2) GetEnableGzipCompression() bool
GetEnableGzipCompression returns the service's EnableGzipCompression field
func (*SecretsManagerV2) GetNotificationsRegistration ¶
func (secretsManager *SecretsManagerV2) GetNotificationsRegistration(getNotificationsRegistrationOptions *GetNotificationsRegistrationOptions) (result *NotificationsRegistration, response *core.DetailedResponse, err error)
GetNotificationsRegistration : Get Event Notifications registration details Get the details of the registration between your Secrets Manager instance and Event Notifications.
func (*SecretsManagerV2) GetNotificationsRegistrationTest ¶
func (secretsManager *SecretsManagerV2) GetNotificationsRegistrationTest(getNotificationsRegistrationTestOptions *GetNotificationsRegistrationTestOptions) (response *core.DetailedResponse, err error)
GetNotificationsRegistrationTest : Send a test event for Event Notifications registrations 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 (*SecretsManagerV2) GetNotificationsRegistrationTestWithContext ¶
func (secretsManager *SecretsManagerV2) GetNotificationsRegistrationTestWithContext(ctx context.Context, getNotificationsRegistrationTestOptions *GetNotificationsRegistrationTestOptions) (response *core.DetailedResponse, err error)
GetNotificationsRegistrationTestWithContext is an alternate form of the GetNotificationsRegistrationTest method which supports a Context parameter
func (*SecretsManagerV2) GetNotificationsRegistrationWithContext ¶
func (secretsManager *SecretsManagerV2) GetNotificationsRegistrationWithContext(ctx context.Context, getNotificationsRegistrationOptions *GetNotificationsRegistrationOptions) (result *NotificationsRegistration, response *core.DetailedResponse, err error)
GetNotificationsRegistrationWithContext is an alternate form of the GetNotificationsRegistration method which supports a Context parameter
func (*SecretsManagerV2) GetSecret ¶
func (secretsManager *SecretsManagerV2) GetSecret(getSecretOptions *GetSecretOptions) (result SecretIntf, 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) operation.
func (*SecretsManagerV2) GetSecretByNameType ¶ added in v2.0.1
func (secretsManager *SecretsManagerV2) GetSecretByNameType(getSecretByNameTypeOptions *GetSecretByNameTypeOptions) (result SecretIntf, response *core.DetailedResponse, err error)
GetSecretByNameType : Get a secret by name Get a secret and its details by specifying the Name and Type 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) operation.
func (*SecretsManagerV2) GetSecretByNameTypeWithContext ¶ added in v2.0.1
func (secretsManager *SecretsManagerV2) GetSecretByNameTypeWithContext(ctx context.Context, getSecretByNameTypeOptions *GetSecretByNameTypeOptions) (result SecretIntf, response *core.DetailedResponse, err error)
GetSecretByNameTypeWithContext is an alternate form of the GetSecretByNameType method which supports a Context parameter
func (*SecretsManagerV2) GetSecretGroup ¶
func (secretsManager *SecretsManagerV2) GetSecretGroup(getSecretGroupOptions *GetSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
GetSecretGroup : Get a secret group Get the properties of an existing secret group by specifying the ID of the group.
func (*SecretsManagerV2) GetSecretGroupWithContext ¶
func (secretsManager *SecretsManagerV2) GetSecretGroupWithContext(ctx context.Context, getSecretGroupOptions *GetSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
GetSecretGroupWithContext is an alternate form of the GetSecretGroup method which supports a Context parameter
func (*SecretsManagerV2) GetSecretMetadata ¶
func (secretsManager *SecretsManagerV2) GetSecretMetadata(getSecretMetadataOptions *GetSecretMetadataOptions) (result SecretMetadataIntf, response *core.DetailedResponse, err error)
GetSecretMetadata : Get the metadata of a secret Get the metadata of a secret by specifying the ID of the secret.
func (*SecretsManagerV2) GetSecretMetadataWithContext ¶
func (secretsManager *SecretsManagerV2) GetSecretMetadataWithContext(ctx context.Context, getSecretMetadataOptions *GetSecretMetadataOptions) (result SecretMetadataIntf, response *core.DetailedResponse, err error)
GetSecretMetadataWithContext is an alternate form of the GetSecretMetadata method which supports a Context parameter
func (*SecretsManagerV2) GetSecretVersion ¶
func (secretsManager *SecretsManagerV2) GetSecretVersion(getSecretVersionOptions *GetSecretVersionOptions) (result SecretVersionIntf, 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. You can use the `current` or `previous` aliases to refer to the current or previous secret version.
A successful request returns the secret data that is associated with the specified version of your secret, along with other metadata.
func (*SecretsManagerV2) GetSecretVersionMetadata ¶
func (secretsManager *SecretsManagerV2) GetSecretVersionMetadata(getSecretVersionMetadataOptions *GetSecretVersionMetadataOptions) (result SecretVersionMetadataIntf, 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. You can use the `current` or `previous` aliases to refer to the current or previous secret version.
A successful request returns the metadata that is associated with the specified version of your secret.
func (*SecretsManagerV2) GetSecretVersionMetadataWithContext ¶
func (secretsManager *SecretsManagerV2) GetSecretVersionMetadataWithContext(ctx context.Context, getSecretVersionMetadataOptions *GetSecretVersionMetadataOptions) (result SecretVersionMetadataIntf, response *core.DetailedResponse, err error)
GetSecretVersionMetadataWithContext is an alternate form of the GetSecretVersionMetadata method which supports a Context parameter
func (*SecretsManagerV2) GetSecretVersionWithContext ¶
func (secretsManager *SecretsManagerV2) GetSecretVersionWithContext(ctx context.Context, getSecretVersionOptions *GetSecretVersionOptions) (result SecretVersionIntf, response *core.DetailedResponse, err error)
GetSecretVersionWithContext is an alternate form of the GetSecretVersion method which supports a Context parameter
func (*SecretsManagerV2) GetSecretWithContext ¶
func (secretsManager *SecretsManagerV2) GetSecretWithContext(ctx context.Context, getSecretOptions *GetSecretOptions) (result SecretIntf, response *core.DetailedResponse, err error)
GetSecretWithContext is an alternate form of the GetSecret method which supports a Context parameter
func (*SecretsManagerV2) GetServiceURL ¶
func (secretsManager *SecretsManagerV2) GetServiceURL() string
GetServiceURL returns the service URL
func (*SecretsManagerV2) ListConfigurations ¶
func (secretsManager *SecretsManagerV2) ListConfigurations(listConfigurationsOptions *ListConfigurationsOptions) (result *ConfigurationMetadataPaginatedCollection, response *core.DetailedResponse, err error)
ListConfigurations : List configurations List the configurations that are available in your Secrets Manager instance.
func (*SecretsManagerV2) ListConfigurationsWithContext ¶
func (secretsManager *SecretsManagerV2) ListConfigurationsWithContext(ctx context.Context, listConfigurationsOptions *ListConfigurationsOptions) (result *ConfigurationMetadataPaginatedCollection, response *core.DetailedResponse, err error)
ListConfigurationsWithContext is an alternate form of the ListConfigurations method which supports a Context parameter
func (*SecretsManagerV2) ListSecretGroups ¶
func (secretsManager *SecretsManagerV2) ListSecretGroups(listSecretGroupsOptions *ListSecretGroupsOptions) (result *SecretGroupCollection, response *core.DetailedResponse, err error)
ListSecretGroups : List secret groups List the secret groups that are available in your Secrets Manager instance.
func (*SecretsManagerV2) ListSecretGroupsWithContext ¶
func (secretsManager *SecretsManagerV2) ListSecretGroupsWithContext(ctx context.Context, listSecretGroupsOptions *ListSecretGroupsOptions) (result *SecretGroupCollection, response *core.DetailedResponse, err error)
ListSecretGroupsWithContext is an alternate form of the ListSecretGroups method which supports a Context parameter
func (*SecretsManagerV2) ListSecretLocks ¶
func (secretsManager *SecretsManagerV2) ListSecretLocks(listSecretLocksOptions *ListSecretLocksOptions) (result *SecretLocksPaginatedCollection, response *core.DetailedResponse, err error)
ListSecretLocks : List secret locks List the locks that are associated with a specified secret.
func (*SecretsManagerV2) ListSecretLocksWithContext ¶
func (secretsManager *SecretsManagerV2) ListSecretLocksWithContext(ctx context.Context, listSecretLocksOptions *ListSecretLocksOptions) (result *SecretLocksPaginatedCollection, response *core.DetailedResponse, err error)
ListSecretLocksWithContext is an alternate form of the ListSecretLocks method which supports a Context parameter
func (*SecretsManagerV2) ListSecretVersionLocks ¶
func (secretsManager *SecretsManagerV2) ListSecretVersionLocks(listSecretVersionLocksOptions *ListSecretVersionLocksOptions) (result *SecretVersionLocksPaginatedCollection, response *core.DetailedResponse, err error)
ListSecretVersionLocks : List secret version locks List the locks that are associated with a specified secret version.
func (*SecretsManagerV2) ListSecretVersionLocksWithContext ¶
func (secretsManager *SecretsManagerV2) ListSecretVersionLocksWithContext(ctx context.Context, listSecretVersionLocksOptions *ListSecretVersionLocksOptions) (result *SecretVersionLocksPaginatedCollection, response *core.DetailedResponse, err error)
ListSecretVersionLocksWithContext is an alternate form of the ListSecretVersionLocks method which supports a Context parameter
func (*SecretsManagerV2) ListSecretVersions ¶
func (secretsManager *SecretsManagerV2) ListSecretVersions(listSecretVersionsOptions *ListSecretVersionsOptions) (result *SecretVersionMetadataCollection, response *core.DetailedResponse, err error)
ListSecretVersions : List versions of a secret List the versions of a secret.
A successful request returns the list of versions of a secret, along with the metadata of each version.
func (*SecretsManagerV2) ListSecretVersionsWithContext ¶
func (secretsManager *SecretsManagerV2) ListSecretVersionsWithContext(ctx context.Context, listSecretVersionsOptions *ListSecretVersionsOptions) (result *SecretVersionMetadataCollection, response *core.DetailedResponse, err error)
ListSecretVersionsWithContext is an alternate form of the ListSecretVersions method which supports a Context parameter
func (*SecretsManagerV2) ListSecrets ¶
func (secretsManager *SecretsManagerV2) ListSecrets(listSecretsOptions *ListSecretsOptions) (result *SecretMetadataPaginatedCollection, response *core.DetailedResponse, err error)
ListSecrets : List secrets List the secrets that are available in your Secrets Manager instance.
func (*SecretsManagerV2) ListSecretsLocks ¶
func (secretsManager *SecretsManagerV2) ListSecretsLocks(listSecretsLocksOptions *ListSecretsLocksOptions) (result *SecretsLocksPaginatedCollection, response *core.DetailedResponse, err error)
ListSecretsLocks : List secrets and their locks List the secrets and their locks in your Secrets Manager instance.
func (*SecretsManagerV2) ListSecretsLocksWithContext ¶
func (secretsManager *SecretsManagerV2) ListSecretsLocksWithContext(ctx context.Context, listSecretsLocksOptions *ListSecretsLocksOptions) (result *SecretsLocksPaginatedCollection, response *core.DetailedResponse, err error)
ListSecretsLocksWithContext is an alternate form of the ListSecretsLocks method which supports a Context parameter
func (*SecretsManagerV2) ListSecretsWithContext ¶
func (secretsManager *SecretsManagerV2) ListSecretsWithContext(ctx context.Context, listSecretsOptions *ListSecretsOptions) (result *SecretMetadataPaginatedCollection, response *core.DetailedResponse, err error)
ListSecretsWithContext is an alternate form of the ListSecrets method which supports a Context parameter
func (*SecretsManagerV2) NewArbitrarySecretPrototype ¶
func (*SecretsManagerV2) NewArbitrarySecretPrototype(name string, secretType string, payload string) (_model *ArbitrarySecretPrototype, err error)
NewArbitrarySecretPrototype : Instantiate ArbitrarySecretPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewArbitrarySecretVersionPrototype ¶
func (*SecretsManagerV2) NewArbitrarySecretVersionPrototype(payload string) (_model *ArbitrarySecretVersionPrototype, err error)
NewArbitrarySecretVersionPrototype : Instantiate ArbitrarySecretVersionPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewCommonRotationPolicy ¶
func (*SecretsManagerV2) NewCommonRotationPolicy(autoRotate bool) (_model *CommonRotationPolicy, err error)
NewCommonRotationPolicy : Instantiate CommonRotationPolicy (Generic Model Constructor)
func (*SecretsManagerV2) NewConfigurationsPager ¶
func (secretsManager *SecretsManagerV2) NewConfigurationsPager(options *ListConfigurationsOptions) (pager *ConfigurationsPager, err error)
NewConfigurationsPager returns a new ConfigurationsPager instance.
func (*SecretsManagerV2) NewCreateConfigurationActionOptions ¶
func (*SecretsManagerV2) NewCreateConfigurationActionOptions(name string, configActionPrototype ConfigurationActionPrototypeIntf) *CreateConfigurationActionOptions
NewCreateConfigurationActionOptions : Instantiate CreateConfigurationActionOptions
func (*SecretsManagerV2) NewCreateConfigurationOptions ¶
func (*SecretsManagerV2) NewCreateConfigurationOptions(configurationPrototype ConfigurationPrototypeIntf) *CreateConfigurationOptions
NewCreateConfigurationOptions : Instantiate CreateConfigurationOptions
func (*SecretsManagerV2) NewCreateNotificationsRegistrationOptions ¶
func (*SecretsManagerV2) NewCreateNotificationsRegistrationOptions(eventNotificationsInstanceCrn string, eventNotificationsSourceName string) *CreateNotificationsRegistrationOptions
NewCreateNotificationsRegistrationOptions : Instantiate CreateNotificationsRegistrationOptions
func (*SecretsManagerV2) NewCreateSecretActionOptions ¶
func (*SecretsManagerV2) NewCreateSecretActionOptions(id string, secretActionPrototype SecretActionPrototypeIntf) *CreateSecretActionOptions
NewCreateSecretActionOptions : Instantiate CreateSecretActionOptions
func (*SecretsManagerV2) NewCreateSecretGroupOptions ¶
func (*SecretsManagerV2) NewCreateSecretGroupOptions(name string) *CreateSecretGroupOptions
NewCreateSecretGroupOptions : Instantiate CreateSecretGroupOptions
func (*SecretsManagerV2) NewCreateSecretLocksBulkOptions ¶
func (*SecretsManagerV2) NewCreateSecretLocksBulkOptions(id string, locks []SecretLockPrototype) *CreateSecretLocksBulkOptions
NewCreateSecretLocksBulkOptions : Instantiate CreateSecretLocksBulkOptions
func (*SecretsManagerV2) NewCreateSecretOptions ¶
func (*SecretsManagerV2) NewCreateSecretOptions(secretPrototype SecretPrototypeIntf) *CreateSecretOptions
NewCreateSecretOptions : Instantiate CreateSecretOptions
func (*SecretsManagerV2) NewCreateSecretVersionActionOptions ¶
func (*SecretsManagerV2) NewCreateSecretVersionActionOptions(secretID string, id string, secretVersionActionPrototype SecretVersionActionPrototypeIntf) *CreateSecretVersionActionOptions
NewCreateSecretVersionActionOptions : Instantiate CreateSecretVersionActionOptions
func (*SecretsManagerV2) NewCreateSecretVersionLocksBulkOptions ¶
func (*SecretsManagerV2) NewCreateSecretVersionLocksBulkOptions(secretID string, id string, locks []SecretLockPrototype) *CreateSecretVersionLocksBulkOptions
NewCreateSecretVersionLocksBulkOptions : Instantiate CreateSecretVersionLocksBulkOptions
func (*SecretsManagerV2) NewCreateSecretVersionOptions ¶
func (*SecretsManagerV2) NewCreateSecretVersionOptions(secretID string, secretVersionPrototype SecretVersionPrototypeIntf) *CreateSecretVersionOptions
NewCreateSecretVersionOptions : Instantiate CreateSecretVersionOptions
func (*SecretsManagerV2) NewDeleteConfigurationOptions ¶
func (*SecretsManagerV2) NewDeleteConfigurationOptions(name string) *DeleteConfigurationOptions
NewDeleteConfigurationOptions : Instantiate DeleteConfigurationOptions
func (*SecretsManagerV2) NewDeleteNotificationsRegistrationOptions ¶
func (*SecretsManagerV2) NewDeleteNotificationsRegistrationOptions() *DeleteNotificationsRegistrationOptions
NewDeleteNotificationsRegistrationOptions : Instantiate DeleteNotificationsRegistrationOptions
func (*SecretsManagerV2) NewDeleteSecretGroupOptions ¶
func (*SecretsManagerV2) NewDeleteSecretGroupOptions(id string) *DeleteSecretGroupOptions
NewDeleteSecretGroupOptions : Instantiate DeleteSecretGroupOptions
func (*SecretsManagerV2) NewDeleteSecretLocksBulkOptions ¶
func (*SecretsManagerV2) NewDeleteSecretLocksBulkOptions(id string) *DeleteSecretLocksBulkOptions
NewDeleteSecretLocksBulkOptions : Instantiate DeleteSecretLocksBulkOptions
func (*SecretsManagerV2) NewDeleteSecretOptions ¶
func (*SecretsManagerV2) NewDeleteSecretOptions(id string) *DeleteSecretOptions
NewDeleteSecretOptions : Instantiate DeleteSecretOptions
func (*SecretsManagerV2) NewDeleteSecretVersionDataOptions ¶
func (*SecretsManagerV2) NewDeleteSecretVersionDataOptions(secretID string, id string) *DeleteSecretVersionDataOptions
NewDeleteSecretVersionDataOptions : Instantiate DeleteSecretVersionDataOptions
func (*SecretsManagerV2) NewDeleteSecretVersionLocksBulkOptions ¶
func (*SecretsManagerV2) NewDeleteSecretVersionLocksBulkOptions(secretID string, id string) *DeleteSecretVersionLocksBulkOptions
NewDeleteSecretVersionLocksBulkOptions : Instantiate DeleteSecretVersionLocksBulkOptions
func (*SecretsManagerV2) NewGetConfigurationOptions ¶
func (*SecretsManagerV2) NewGetConfigurationOptions(name string) *GetConfigurationOptions
NewGetConfigurationOptions : Instantiate GetConfigurationOptions
func (*SecretsManagerV2) NewGetNotificationsRegistrationOptions ¶
func (*SecretsManagerV2) NewGetNotificationsRegistrationOptions() *GetNotificationsRegistrationOptions
NewGetNotificationsRegistrationOptions : Instantiate GetNotificationsRegistrationOptions
func (*SecretsManagerV2) NewGetNotificationsRegistrationTestOptions ¶
func (*SecretsManagerV2) NewGetNotificationsRegistrationTestOptions() *GetNotificationsRegistrationTestOptions
NewGetNotificationsRegistrationTestOptions : Instantiate GetNotificationsRegistrationTestOptions
func (*SecretsManagerV2) NewGetSecretByNameTypeOptions ¶ added in v2.0.1
func (*SecretsManagerV2) NewGetSecretByNameTypeOptions(secretType string, name string, secretGroupName string) *GetSecretByNameTypeOptions
NewGetSecretByNameTypeOptions : Instantiate GetSecretByNameTypeOptions
func (*SecretsManagerV2) NewGetSecretGroupOptions ¶
func (*SecretsManagerV2) NewGetSecretGroupOptions(id string) *GetSecretGroupOptions
NewGetSecretGroupOptions : Instantiate GetSecretGroupOptions
func (*SecretsManagerV2) NewGetSecretMetadataOptions ¶
func (*SecretsManagerV2) NewGetSecretMetadataOptions(id string) *GetSecretMetadataOptions
NewGetSecretMetadataOptions : Instantiate GetSecretMetadataOptions
func (*SecretsManagerV2) NewGetSecretOptions ¶
func (*SecretsManagerV2) NewGetSecretOptions(id string) *GetSecretOptions
NewGetSecretOptions : Instantiate GetSecretOptions
func (*SecretsManagerV2) NewGetSecretVersionMetadataOptions ¶
func (*SecretsManagerV2) NewGetSecretVersionMetadataOptions(secretID string, id string) *GetSecretVersionMetadataOptions
NewGetSecretVersionMetadataOptions : Instantiate GetSecretVersionMetadataOptions
func (*SecretsManagerV2) NewGetSecretVersionOptions ¶
func (*SecretsManagerV2) NewGetSecretVersionOptions(secretID string, id string) *GetSecretVersionOptions
NewGetSecretVersionOptions : Instantiate GetSecretVersionOptions
func (*SecretsManagerV2) NewIAMCredentialsConfigurationPatch ¶
func (*SecretsManagerV2) NewIAMCredentialsConfigurationPatch(apiKey string) (_model *IAMCredentialsConfigurationPatch, err error)
NewIAMCredentialsConfigurationPatch : Instantiate IAMCredentialsConfigurationPatch (Generic Model Constructor)
func (*SecretsManagerV2) NewIAMCredentialsConfigurationPrototype ¶
func (*SecretsManagerV2) NewIAMCredentialsConfigurationPrototype(name string, configType string, apiKey string) (_model *IAMCredentialsConfigurationPrototype, err error)
NewIAMCredentialsConfigurationPrototype : Instantiate IAMCredentialsConfigurationPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewIAMCredentialsSecretPrototype ¶
func (*SecretsManagerV2) NewIAMCredentialsSecretPrototype(secretType string, name string, ttl string, reuseApiKey bool) (_model *IAMCredentialsSecretPrototype, err error)
NewIAMCredentialsSecretPrototype : Instantiate IAMCredentialsSecretPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewIAMCredentialsSecretRestoreFromVersionPrototype ¶
func (*SecretsManagerV2) NewIAMCredentialsSecretRestoreFromVersionPrototype(restoreFromVersion string) (_model *IAMCredentialsSecretRestoreFromVersionPrototype, err error)
NewIAMCredentialsSecretRestoreFromVersionPrototype : Instantiate IAMCredentialsSecretRestoreFromVersionPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewImportedCertificatePrototype ¶
func (*SecretsManagerV2) NewImportedCertificatePrototype(secretType string, name string, certificate string) (_model *ImportedCertificatePrototype, err error)
NewImportedCertificatePrototype : Instantiate ImportedCertificatePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewImportedCertificateVersionPrototype ¶
func (*SecretsManagerV2) NewImportedCertificateVersionPrototype(certificate string) (_model *ImportedCertificateVersionPrototype, err error)
NewImportedCertificateVersionPrototype : Instantiate ImportedCertificateVersionPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewKVSecretPrototype ¶
func (*SecretsManagerV2) NewKVSecretPrototype(secretType string, name string, data map[string]interface{}) (_model *KVSecretPrototype, err error)
NewKVSecretPrototype : Instantiate KVSecretPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewKVSecretVersionPrototype ¶
func (*SecretsManagerV2) NewKVSecretVersionPrototype(data map[string]interface{}) (_model *KVSecretVersionPrototype, err error)
NewKVSecretVersionPrototype : Instantiate KVSecretVersionPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewListConfigurationsOptions ¶
func (*SecretsManagerV2) NewListConfigurationsOptions() *ListConfigurationsOptions
NewListConfigurationsOptions : Instantiate ListConfigurationsOptions
func (*SecretsManagerV2) NewListSecretGroupsOptions ¶
func (*SecretsManagerV2) NewListSecretGroupsOptions() *ListSecretGroupsOptions
NewListSecretGroupsOptions : Instantiate ListSecretGroupsOptions
func (*SecretsManagerV2) NewListSecretLocksOptions ¶
func (*SecretsManagerV2) NewListSecretLocksOptions(id string) *ListSecretLocksOptions
NewListSecretLocksOptions : Instantiate ListSecretLocksOptions
func (*SecretsManagerV2) NewListSecretVersionLocksOptions ¶
func (*SecretsManagerV2) NewListSecretVersionLocksOptions(secretID string, id string) *ListSecretVersionLocksOptions
NewListSecretVersionLocksOptions : Instantiate ListSecretVersionLocksOptions
func (*SecretsManagerV2) NewListSecretVersionsOptions ¶
func (*SecretsManagerV2) NewListSecretVersionsOptions(secretID string) *ListSecretVersionsOptions
NewListSecretVersionsOptions : Instantiate ListSecretVersionsOptions
func (*SecretsManagerV2) NewListSecretsLocksOptions ¶
func (*SecretsManagerV2) NewListSecretsLocksOptions() *ListSecretsLocksOptions
NewListSecretsLocksOptions : Instantiate ListSecretsLocksOptions
func (*SecretsManagerV2) NewListSecretsOptions ¶
func (*SecretsManagerV2) NewListSecretsOptions() *ListSecretsOptions
NewListSecretsOptions : Instantiate ListSecretsOptions
func (*SecretsManagerV2) NewPrivateCertificateActionRevokePrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateActionRevokePrototype(actionType string) (_model *PrivateCertificateActionRevokePrototype, err error)
NewPrivateCertificateActionRevokePrototype : Instantiate PrivateCertificateActionRevokePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionRevokePrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionRevokePrototype(actionType string) (_model *PrivateCertificateConfigurationActionRevokePrototype, err error)
NewPrivateCertificateConfigurationActionRevokePrototype : Instantiate PrivateCertificateConfigurationActionRevokePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionRotateCRLPrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionRotateCRLPrototype(actionType string) (_model *PrivateCertificateConfigurationActionRotateCRLPrototype, err error)
NewPrivateCertificateConfigurationActionRotateCRLPrototype : Instantiate PrivateCertificateConfigurationActionRotateCRLPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSetSignedPrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSetSignedPrototype(actionType string, certificate string) (_model *PrivateCertificateConfigurationActionSetSignedPrototype, err error)
NewPrivateCertificateConfigurationActionSetSignedPrototype : Instantiate PrivateCertificateConfigurationActionSetSignedPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSignCSRPrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSignCSRPrototype(actionType string, csr string) (_model *PrivateCertificateConfigurationActionSignCSRPrototype, err error)
NewPrivateCertificateConfigurationActionSignCSRPrototype : Instantiate PrivateCertificateConfigurationActionSignCSRPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSignIntermediatePrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateConfigurationActionSignIntermediatePrototype(actionType string, intermediateCertificateAuthority string) (_model *PrivateCertificateConfigurationActionSignIntermediatePrototype, err error)
NewPrivateCertificateConfigurationActionSignIntermediatePrototype : Instantiate PrivateCertificateConfigurationActionSignIntermediatePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateConfigurationIntermediateCAPrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateConfigurationIntermediateCAPrototype(configType string, name string, maxTTL string, signingMethod string, commonName string) (_model *PrivateCertificateConfigurationIntermediateCAPrototype, err error)
NewPrivateCertificateConfigurationIntermediateCAPrototype : Instantiate PrivateCertificateConfigurationIntermediateCAPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateConfigurationRootCAPrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateConfigurationRootCAPrototype(configType string, name string, maxTTL string, commonName string) (_model *PrivateCertificateConfigurationRootCAPrototype, err error)
NewPrivateCertificateConfigurationRootCAPrototype : Instantiate PrivateCertificateConfigurationRootCAPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateConfigurationTemplatePrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateConfigurationTemplatePrototype(configType string, name string, certificateAuthority string) (_model *PrivateCertificateConfigurationTemplatePrototype, err error)
NewPrivateCertificateConfigurationTemplatePrototype : Instantiate PrivateCertificateConfigurationTemplatePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificatePrototype ¶
func (*SecretsManagerV2) NewPrivateCertificatePrototype(secretType string, name string, certificateTemplate string, commonName string) (_model *PrivateCertificatePrototype, err error)
NewPrivateCertificatePrototype : Instantiate PrivateCertificatePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPrivateCertificateVersionActionRevokePrototype ¶
func (*SecretsManagerV2) NewPrivateCertificateVersionActionRevokePrototype(actionType string) (_model *PrivateCertificateVersionActionRevokePrototype, err error)
NewPrivateCertificateVersionActionRevokePrototype : Instantiate PrivateCertificateVersionActionRevokePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificateActionValidateManualDNSPrototype ¶
func (*SecretsManagerV2) NewPublicCertificateActionValidateManualDNSPrototype(actionType string) (_model *PublicCertificateActionValidateManualDNSPrototype, err error)
NewPublicCertificateActionValidateManualDNSPrototype : Instantiate PublicCertificateActionValidateManualDNSPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificateConfigurationCALetsEncryptPatch ¶
func (*SecretsManagerV2) NewPublicCertificateConfigurationCALetsEncryptPatch(letsEncryptEnvironment string) (_model *PublicCertificateConfigurationCALetsEncryptPatch, err error)
NewPublicCertificateConfigurationCALetsEncryptPatch : Instantiate PublicCertificateConfigurationCALetsEncryptPatch (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificateConfigurationCALetsEncryptPrototype ¶
func (*SecretsManagerV2) NewPublicCertificateConfigurationCALetsEncryptPrototype(configType string, name string, letsEncryptEnvironment string, letsEncryptPrivateKey string) (_model *PublicCertificateConfigurationCALetsEncryptPrototype, err error)
NewPublicCertificateConfigurationCALetsEncryptPrototype : Instantiate PublicCertificateConfigurationCALetsEncryptPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSClassicInfrastructurePrototype ¶
func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSClassicInfrastructurePrototype(configType string, name string, classicInfrastructureUsername string, classicInfrastructurePassword string) (_model *PublicCertificateConfigurationDNSClassicInfrastructurePrototype, err error)
NewPublicCertificateConfigurationDNSClassicInfrastructurePrototype : Instantiate PublicCertificateConfigurationDNSClassicInfrastructurePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSCloudInternetServicesPatch ¶
func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSCloudInternetServicesPatch(cloudInternetServicesApikey string) (_model *PublicCertificateConfigurationDNSCloudInternetServicesPatch, err error)
NewPublicCertificateConfigurationDNSCloudInternetServicesPatch : Instantiate PublicCertificateConfigurationDNSCloudInternetServicesPatch (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSCloudInternetServicesPrototype ¶
func (*SecretsManagerV2) NewPublicCertificateConfigurationDNSCloudInternetServicesPrototype(configType string, name string, cloudInternetServicesCrn string) (_model *PublicCertificateConfigurationDNSCloudInternetServicesPrototype, err error)
NewPublicCertificateConfigurationDNSCloudInternetServicesPrototype : Instantiate PublicCertificateConfigurationDNSCloudInternetServicesPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificatePrototype ¶
func (*SecretsManagerV2) NewPublicCertificatePrototype(secretType string, name string, commonName string, ca string, dns string) (_model *PublicCertificatePrototype, err error)
NewPublicCertificatePrototype : Instantiate PublicCertificatePrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificateRotationPolicy ¶
func (*SecretsManagerV2) NewPublicCertificateRotationPolicy(autoRotate bool, rotateKeys bool) (_model *PublicCertificateRotationPolicy, err error)
NewPublicCertificateRotationPolicy : Instantiate PublicCertificateRotationPolicy (Generic Model Constructor)
func (*SecretsManagerV2) NewPublicCertificateVersionPrototype ¶
func (*SecretsManagerV2) NewPublicCertificateVersionPrototype(rotation *PublicCertificateRotationObject) (_model *PublicCertificateVersionPrototype, err error)
NewPublicCertificateVersionPrototype : Instantiate PublicCertificateVersionPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewSecretLockPrototype ¶
func (*SecretsManagerV2) NewSecretLockPrototype(name string) (_model *SecretLockPrototype, err error)
NewSecretLockPrototype : Instantiate SecretLockPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewSecretLocksPager ¶
func (secretsManager *SecretsManagerV2) NewSecretLocksPager(options *ListSecretLocksOptions) (pager *SecretLocksPager, err error)
NewSecretLocksPager returns a new SecretLocksPager instance.
func (*SecretsManagerV2) NewSecretVersionLocksPager ¶
func (secretsManager *SecretsManagerV2) NewSecretVersionLocksPager(options *ListSecretVersionLocksOptions) (pager *SecretVersionLocksPager, err error)
NewSecretVersionLocksPager returns a new SecretVersionLocksPager instance.
func (*SecretsManagerV2) NewSecretsLocksPager ¶
func (secretsManager *SecretsManagerV2) NewSecretsLocksPager(options *ListSecretsLocksOptions) (pager *SecretsLocksPager, err error)
NewSecretsLocksPager returns a new SecretsLocksPager instance.
func (*SecretsManagerV2) NewSecretsPager ¶
func (secretsManager *SecretsManagerV2) NewSecretsPager(options *ListSecretsOptions) (pager *SecretsPager, err error)
NewSecretsPager returns a new SecretsPager instance.
func (*SecretsManagerV2) NewServiceCredentialsSecretPrototype ¶ added in v2.0.2
func (*SecretsManagerV2) NewServiceCredentialsSecretPrototype(name string, secretType string, sourceService *ServiceCredentialsSecretSourceService) (_model *ServiceCredentialsSecretPrototype, err error)
NewServiceCredentialsSecretPrototype : Instantiate ServiceCredentialsSecretPrototype (Generic Model Constructor)
func (*SecretsManagerV2) NewServiceCredentialsSecretSourceService ¶ added in v2.0.2
func (*SecretsManagerV2) NewServiceCredentialsSecretSourceService(instance *ServiceCredentialsSourceServiceInstance) (_model *ServiceCredentialsSecretSourceService, err error)
NewServiceCredentialsSecretSourceService : Instantiate ServiceCredentialsSecretSourceService (Generic Model Constructor)
func (*SecretsManagerV2) NewServiceCredentialsSourceServiceRole ¶ added in v2.0.2
func (*SecretsManagerV2) NewServiceCredentialsSourceServiceRole(crn string) (_model *ServiceCredentialsSourceServiceRole, err error)
NewServiceCredentialsSourceServiceRole : Instantiate ServiceCredentialsSourceServiceRole (Generic Model Constructor)
func (*SecretsManagerV2) NewUpdateConfigurationOptions ¶
func (*SecretsManagerV2) NewUpdateConfigurationOptions(name string, configurationPatch map[string]interface{}) *UpdateConfigurationOptions
NewUpdateConfigurationOptions : Instantiate UpdateConfigurationOptions
func (*SecretsManagerV2) NewUpdateSecretGroupOptions ¶
func (*SecretsManagerV2) NewUpdateSecretGroupOptions(id string, secretGroupPatch map[string]interface{}) *UpdateSecretGroupOptions
NewUpdateSecretGroupOptions : Instantiate UpdateSecretGroupOptions
func (*SecretsManagerV2) NewUpdateSecretMetadataOptions ¶
func (*SecretsManagerV2) NewUpdateSecretMetadataOptions(id string, secretMetadataPatch map[string]interface{}) *UpdateSecretMetadataOptions
NewUpdateSecretMetadataOptions : Instantiate UpdateSecretMetadataOptions
func (*SecretsManagerV2) NewUpdateSecretVersionMetadataOptions ¶
func (*SecretsManagerV2) NewUpdateSecretVersionMetadataOptions(secretID string, id string, secretVersionMetadataPatch map[string]interface{}) *UpdateSecretVersionMetadataOptions
NewUpdateSecretVersionMetadataOptions : Instantiate UpdateSecretVersionMetadataOptions
func (*SecretsManagerV2) NewUsernamePasswordSecretPrototype ¶
func (*SecretsManagerV2) NewUsernamePasswordSecretPrototype(secretType string, name string, username string) (_model *UsernamePasswordSecretPrototype, err error)
NewUsernamePasswordSecretPrototype : Instantiate UsernamePasswordSecretPrototype (Generic Model Constructor)
func (*SecretsManagerV2) SetDefaultHeaders ¶
func (secretsManager *SecretsManagerV2) SetDefaultHeaders(headers http.Header)
SetDefaultHeaders sets HTTP headers to be sent in every request
func (*SecretsManagerV2) SetEnableGzipCompression ¶
func (secretsManager *SecretsManagerV2) SetEnableGzipCompression(enableGzip bool)
SetEnableGzipCompression sets the service's EnableGzipCompression field
func (*SecretsManagerV2) SetServiceURL ¶
func (secretsManager *SecretsManagerV2) SetServiceURL(url string) error
SetServiceURL sets the service URL
func (*SecretsManagerV2) UpdateConfiguration ¶
func (secretsManager *SecretsManagerV2) UpdateConfiguration(updateConfigurationOptions *UpdateConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
UpdateConfiguration : Update configuration Update a configuration.
func (*SecretsManagerV2) UpdateConfigurationWithContext ¶
func (secretsManager *SecretsManagerV2) UpdateConfigurationWithContext(ctx context.Context, updateConfigurationOptions *UpdateConfigurationOptions) (result ConfigurationIntf, response *core.DetailedResponse, err error)
UpdateConfigurationWithContext is an alternate form of the UpdateConfiguration method which supports a Context parameter
func (*SecretsManagerV2) UpdateSecretGroup ¶
func (secretsManager *SecretsManagerV2) UpdateSecretGroup(updateSecretGroupOptions *UpdateSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
UpdateSecretGroup : Update a secret group Update the properties of an existing secret group, such as its name or description.
func (*SecretsManagerV2) UpdateSecretGroupWithContext ¶
func (secretsManager *SecretsManagerV2) UpdateSecretGroupWithContext(ctx context.Context, updateSecretGroupOptions *UpdateSecretGroupOptions) (result *SecretGroup, response *core.DetailedResponse, err error)
UpdateSecretGroupWithContext is an alternate form of the UpdateSecretGroup method which supports a Context parameter
func (*SecretsManagerV2) UpdateSecretMetadata ¶
func (secretsManager *SecretsManagerV2) UpdateSecretMetadata(updateSecretMetadataOptions *UpdateSecretMetadataOptions) (result SecretMetadataIntf, response *core.DetailedResponse, err error)
UpdateSecretMetadata : Update the metadata of a secret Update the metadata of a secret, such as its name or description.
func (*SecretsManagerV2) UpdateSecretMetadataWithContext ¶
func (secretsManager *SecretsManagerV2) UpdateSecretMetadataWithContext(ctx context.Context, updateSecretMetadataOptions *UpdateSecretMetadataOptions) (result SecretMetadataIntf, response *core.DetailedResponse, err error)
UpdateSecretMetadataWithContext is an alternate form of the UpdateSecretMetadata method which supports a Context parameter
func (*SecretsManagerV2) UpdateSecretVersionMetadata ¶
func (secretsManager *SecretsManagerV2) UpdateSecretVersionMetadata(updateSecretVersionMetadataOptions *UpdateSecretVersionMetadataOptions) (result SecretVersionMetadataIntf, response *core.DetailedResponse, err error)
UpdateSecretVersionMetadata : Update the metadata of a secret version Update the custom metadata of a secret version.
func (*SecretsManagerV2) UpdateSecretVersionMetadataWithContext ¶
func (secretsManager *SecretsManagerV2) UpdateSecretVersionMetadataWithContext(ctx context.Context, updateSecretVersionMetadataOptions *UpdateSecretVersionMetadataOptions) (result SecretVersionMetadataIntf, response *core.DetailedResponse, err error)
UpdateSecretVersionMetadataWithContext is an alternate form of the UpdateSecretVersionMetadata method which supports a Context parameter
type SecretsManagerV2Options ¶
type SecretsManagerV2Options struct {
ServiceName string
URL string
Authenticator core.Authenticator
}
SecretsManagerV2Options : Service options
type SecretsPager ¶
type SecretsPager struct {
// contains filtered or unexported fields
}
SecretsPager can be used to simplify the use of the "ListSecrets" method.
func (*SecretsPager) GetAll ¶
func (pager *SecretsPager) GetAll() (allItems []SecretMetadataIntf, err error)
GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.
func (*SecretsPager) GetAllWithContext ¶
func (pager *SecretsPager) GetAllWithContext(ctx context.Context) (allItems []SecretMetadataIntf, err error)
GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.
func (*SecretsPager) GetNext ¶
func (pager *SecretsPager) GetNext() (page []SecretMetadataIntf, err error)
GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.
func (*SecretsPager) GetNextWithContext ¶
func (pager *SecretsPager) GetNextWithContext(ctx context.Context) (page []SecretMetadataIntf, err error)
GetNextWithContext returns the next page of results using the specified Context.
func (*SecretsPager) HasNext ¶
func (pager *SecretsPager) HasNext() bool
HasNext returns true if there are potentially more results to be retrieved.
type ServiceCredentialsResourceKey ¶ added in v2.0.2
type ServiceCredentialsResourceKey struct {
// The resource key CRN of the generated service credentials.
Crn *string `json:"crn,omitempty"`
// The resource key name of the generated service credentials.
Name *string `json:"name,omitempty"`
}
ServiceCredentialsResourceKey : The source service resource key data of the generated service credentials.
type ServiceCredentialsSecret ¶ added in v2.0.2
type ServiceCredentialsSecret struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// 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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The properties of the resource key that was created for this source service instance.
SourceService *ServiceCredentialsSecretSourceServiceRO `json:"source_service" validate:"required"`
// The properties of the service credentials secret payload.
Credentials *ServiceCredentialsSecretCredentials `json:"credentials" validate:"required"`
}
ServiceCredentialsSecret : Your service credentials secret. This model "extends" Secret
type ServiceCredentialsSecretCredentials ¶ added in v2.0.2
type ServiceCredentialsSecretCredentials struct {
// The API key that is generated for this secret.
//
// After the secret reaches the end of its lease, the API key is deleted automatically. See the `time-to-live` field to
// understand the duration of the lease.
Apikey *string `json:"apikey,omitempty"`
// The IAM API key description for the generated service credentials.
IamApikeyDescription *string `json:"iam_apikey_description,omitempty"`
// The IAM API key id for the generated service credentials.
IamApikeyID *string `json:"iam_apikey_id,omitempty"`
// The IAM API key name for the generated service credentials.
IamApikeyName *string `json:"iam_apikey_name,omitempty"`
// The IAM role CRN assigned to the generated service credentials.
IamRoleCrn *string `json:"iam_role_crn,omitempty"`
// The IAM Service ID CRN.
IamServiceidCrn *string `json:"iam_serviceid_crn,omitempty"`
// contains filtered or unexported fields
}
ServiceCredentialsSecretCredentials : The properties of the service credentials secret payload.
func (*ServiceCredentialsSecretCredentials) GetProperties ¶ added in v2.0.3
func (o *ServiceCredentialsSecretCredentials) GetProperties() map[string]interface{}
GetProperties allows the user to retrieve the map of arbitrary properties from an instance of ServiceCredentialsSecretCredentials
func (*ServiceCredentialsSecretCredentials) GetProperty ¶ added in v2.0.3
func (o *ServiceCredentialsSecretCredentials) GetProperty(key string) interface{}
GetProperty allows the user to retrieve an arbitrary property from an instance of ServiceCredentialsSecretCredentials
func (*ServiceCredentialsSecretCredentials) MarshalJSON ¶ added in v2.0.3
func (o *ServiceCredentialsSecretCredentials) MarshalJSON() (buffer []byte, err error)
MarshalJSON performs custom serialization for instances of ServiceCredentialsSecretCredentials
func (*ServiceCredentialsSecretCredentials) SetProperties ¶ added in v2.0.3
func (o *ServiceCredentialsSecretCredentials) SetProperties(m map[string]interface{})
SetProperties allows the user to set a map of arbitrary properties on an instance of ServiceCredentialsSecretCredentials
func (*ServiceCredentialsSecretCredentials) SetProperty ¶ added in v2.0.3
func (o *ServiceCredentialsSecretCredentials) SetProperty(key string, value interface{})
SetProperty allows the user to set an arbitrary property on an instance of ServiceCredentialsSecretCredentials
type ServiceCredentialsSecretMetadata ¶ added in v2.0.2
type ServiceCredentialsSecretMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// 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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The properties of the resource key that was created for this source service instance.
SourceService *ServiceCredentialsSecretSourceServiceRO `json:"source_service" validate:"required"`
}
ServiceCredentialsSecretMetadata : The metadata properties for your service credentials secret. This model "extends" SecretMetadata
type ServiceCredentialsSecretMetadataPatch ¶ added in v2.0.2
type ServiceCredentialsSecretMetadataPatch struct {
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.
Name *string `json:"name,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
}
ServiceCredentialsSecretMetadataPatch : ServiceCredentialsSecretMetadataPatch struct This model "extends" SecretMetadataPatch
func (*ServiceCredentialsSecretMetadataPatch) AsPatch ¶ added in v2.0.2
func (serviceCredentialsSecretMetadataPatch *ServiceCredentialsSecretMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the ServiceCredentialsSecretMetadataPatch
type ServiceCredentialsSecretPrototype ¶ added in v2.0.2
type ServiceCredentialsSecretPrototype struct {
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.
Name *string `json:"name" validate:"required"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The properties that are required to create the service credentials for the specified source service instance.
SourceService *ServiceCredentialsSecretSourceService `json:"source_service" validate:"required"`
// The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types:
// iam_credentials, service_credentials. The TTL defines how long generated credentials remain valid. The value can be
// either an integer that specifies the number of seconds, or the string representation of a duration, such as `1440m`
// or `24h`. For the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The
// maximum is 90 days. For the service_credentials secret type, the TTL field is optional. If it is set the minimum
// duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0.
TTL *string `json:"ttl,omitempty"`
// The secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
}
ServiceCredentialsSecretPrototype : ServiceCredentialsSecretPrototype struct This model "extends" SecretPrototype
type ServiceCredentialsSecretSourceService ¶ added in v2.0.2
type ServiceCredentialsSecretSourceService struct {
// The source service instance identifier.
Instance *ServiceCredentialsSourceServiceInstance `json:"instance" validate:"required"`
// Configuration options represented as key-value pairs. Service-defined options are used in the generation of
// credentials for some services. For example, Cloud Object Storage accepts the optional boolean parameter HMAC for
// creating specific kind of credentials.
Parameters *ServiceCredentialsSourceServiceParameters `json:"parameters,omitempty"`
// The service-specific custom role. CRN is accepted. The role is assigned as part of an access policy to any
// auto-generated IAM service ID. If you provide an existing service ID, it is added to the access policy for that ID.
// If a role is not provided, any new service IDs that are autogenerated, will not have an assigned access policy and
// provided service IDs are not changed in any way. Refer to the service documentation for supported roles.
Role *ServiceCredentialsSourceServiceRole `json:"role,omitempty"`
}
ServiceCredentialsSecretSourceService : The properties that are required to create the service credentials for the specified source service instance.
type ServiceCredentialsSecretSourceServiceRO ¶ added in v2.0.3
type ServiceCredentialsSecretSourceServiceRO struct {
// The source service instance identifier.
Instance *ServiceCredentialsSourceServiceInstance `json:"instance" validate:"required"`
// Configuration options represented as key-value pairs. Service-defined options are used in the generation of
// credentials for some services. For example, Cloud Object Storage accepts the optional boolean parameter HMAC for
// creating specific kind of credentials.
Parameters *ServiceCredentialsSourceServiceParameters `json:"parameters,omitempty"`
// The service-specific custom role. CRN is accepted. The role is assigned as part of an access policy to any
// auto-generated IAM service ID. If you provide an existing service ID, it is added to the access policy for that ID.
// If a role is not provided, any new service IDs that are autogenerated, will not have an assigned access policy and
// provided service IDs are not changed in any way. Refer to the service documentation for supported roles.
Role *ServiceCredentialsSourceServiceRole `json:"role,omitempty"`
// The source service IAM data is returned in case IAM credentials where created for this secret.
Iam *ServiceCredentialsSourceServiceIam `json:"iam,omitempty"`
// The source service resource key data of the generated service credentials.
ResourceKey *ServiceCredentialsResourceKey `json:"resource_key,omitempty"`
}
ServiceCredentialsSecretSourceServiceRO : The properties of the resource key that was created for this source service instance.
type ServiceCredentialsSecretVersion ¶ added in v2.0.2
type ServiceCredentialsSecretVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The source service resource key data of the generated service credentials.
ResourceKey *ServiceCredentialsResourceKey `json:"resource_key,omitempty"`
// The properties of the service credentials secret payload.
Credentials *ServiceCredentialsSecretCredentials `json:"credentials" validate:"required"`
}
ServiceCredentialsSecretVersion : Your service credentials secret version. This model "extends" SecretVersion
type ServiceCredentialsSecretVersionMetadata ¶ added in v2.0.2
type ServiceCredentialsSecretVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// The source service resource key data of the generated service credentials.
ResourceKey *ServiceCredentialsResourceKey `json:"resource_key,omitempty"`
}
ServiceCredentialsSecretVersionMetadata : The version metadata properties for your service credentials secret. This model "extends" SecretVersionMetadata
type ServiceCredentialsSecretVersionPrototype ¶ added in v2.0.2
type ServiceCredentialsSecretVersionPrototype struct {
// 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"`
}
ServiceCredentialsSecretVersionPrototype : ServiceCredentialsSecretVersionPrototype struct This model "extends" SecretVersionPrototype
type ServiceCredentialsSourceServiceIam ¶ added in v2.0.2
type ServiceCredentialsSourceServiceIam struct {
// The IAM apikey metadata for the IAM credentials that were generated.
Apikey *ServiceCredentialsSourceServiceIamApikey `json:"apikey,omitempty"`
// The IAM role for the generate service credentials.
Role *ServiceCredentialsSourceServiceIamRole `json:"role,omitempty"`
// The IAM serviceid for the generated service credentials.
Serviceid *ServiceCredentialsSourceServiceIamServiceid `json:"serviceid,omitempty"`
}
ServiceCredentialsSourceServiceIam : The source service IAM data is returned in case IAM credentials where created for this secret.
type ServiceCredentialsSourceServiceIamApikey ¶ added in v2.0.2
type ServiceCredentialsSourceServiceIamApikey struct {
// The IAM API key description for the generated service credentials.
Description *string `json:"description,omitempty"`
// The IAM API key id for the generated service credentials.
ID *string `json:"id,omitempty"`
// The IAM API key name for the generated service credentials.
Name *string `json:"name,omitempty"`
}
ServiceCredentialsSourceServiceIamApikey : The IAM apikey metadata for the IAM credentials that were generated.
type ServiceCredentialsSourceServiceIamRole ¶ added in v2.0.2
type ServiceCredentialsSourceServiceIamRole struct {
// The IAM role CRN assigned to the generated service credentials.
Crn *string `json:"crn,omitempty"`
}
ServiceCredentialsSourceServiceIamRole : The IAM role for the generate service credentials.
type ServiceCredentialsSourceServiceIamServiceid ¶ added in v2.0.2
type ServiceCredentialsSourceServiceIamServiceid struct {
// The IAM Service ID CRN.
Crn *string `json:"crn,omitempty"`
}
ServiceCredentialsSourceServiceIamServiceid : The IAM serviceid for the generated service credentials.
type ServiceCredentialsSourceServiceInstance ¶ added in v2.0.2
type ServiceCredentialsSourceServiceInstance struct {
// A CRN that uniquely identifies a service credentials source.
Crn *string `json:"crn,omitempty"`
}
ServiceCredentialsSourceServiceInstance : The source service instance identifier.
type ServiceCredentialsSourceServiceParameters ¶ added in v2.0.2
type ServiceCredentialsSourceServiceParameters struct {
// An optional platform defined option to reuse an existing IAM Service ID for the role assignment.
ServiceidCrn *string `json:"serviceid_crn,omitempty"`
// contains filtered or unexported fields
}
ServiceCredentialsSourceServiceParameters : Configuration options represented as key-value pairs. Service-defined options are used in the generation of credentials for some services. For example, Cloud Object Storage accepts the optional boolean parameter HMAC for creating specific kind of credentials.
func (*ServiceCredentialsSourceServiceParameters) GetProperties ¶ added in v2.0.2
func (o *ServiceCredentialsSourceServiceParameters) GetProperties() map[string]interface{}
GetProperties allows the user to retrieve the map of arbitrary properties from an instance of ServiceCredentialsSourceServiceParameters
func (*ServiceCredentialsSourceServiceParameters) GetProperty ¶ added in v2.0.2
func (o *ServiceCredentialsSourceServiceParameters) GetProperty(key string) interface{}
GetProperty allows the user to retrieve an arbitrary property from an instance of ServiceCredentialsSourceServiceParameters
func (*ServiceCredentialsSourceServiceParameters) MarshalJSON ¶ added in v2.0.2
func (o *ServiceCredentialsSourceServiceParameters) MarshalJSON() (buffer []byte, err error)
MarshalJSON performs custom serialization for instances of ServiceCredentialsSourceServiceParameters
func (*ServiceCredentialsSourceServiceParameters) SetProperties ¶ added in v2.0.2
func (o *ServiceCredentialsSourceServiceParameters) SetProperties(m map[string]interface{})
SetProperties allows the user to set a map of arbitrary properties on an instance of ServiceCredentialsSourceServiceParameters
func (*ServiceCredentialsSourceServiceParameters) SetProperty ¶ added in v2.0.2
func (o *ServiceCredentialsSourceServiceParameters) SetProperty(key string, value interface{})
SetProperty allows the user to set an arbitrary property on an instance of ServiceCredentialsSourceServiceParameters
type ServiceCredentialsSourceServiceRole ¶ added in v2.0.2
type ServiceCredentialsSourceServiceRole struct {
// The service role CRN.
Crn *string `json:"crn" validate:"required"`
}
ServiceCredentialsSourceServiceRole : The service-specific custom role. CRN is accepted. The role is assigned as part of an access policy to any auto-generated IAM service ID. If you provide an existing service ID, it is added to the access policy for that ID. If a role is not provided, any new service IDs that are autogenerated, will not have an assigned access policy and provided service IDs are not changed in any way. Refer to the service documentation for supported roles.
type UpdateConfigurationOptions ¶
type UpdateConfigurationOptions struct {
// The name that uniquely identifies a configuration.
Name *string `json:"name" validate:"required,ne="`
// JSON Merge-Patch content for update_configuration.
ConfigurationPatch map[string]interface{} `json:"ConfigurationPatch" validate:"required"`
// The configuration type of this configuration - use this header to resolve 300 error responses.
XSmAcceptConfigurationType *string `json:"X-Sm-Accept-Configuration-Type,omitempty"`
// Allows users to set headers on API requests
Headers map[string]string
}
UpdateConfigurationOptions : The UpdateConfiguration options.
func (*UpdateConfigurationOptions) SetConfigurationPatch ¶
func (_options *UpdateConfigurationOptions) SetConfigurationPatch(configurationPatch map[string]interface{}) *UpdateConfigurationOptions
SetConfigurationPatch : Allow user to set ConfigurationPatch
func (*UpdateConfigurationOptions) SetHeaders ¶
func (options *UpdateConfigurationOptions) SetHeaders(param map[string]string) *UpdateConfigurationOptions
SetHeaders : Allow user to set Headers
func (*UpdateConfigurationOptions) SetName ¶
func (_options *UpdateConfigurationOptions) SetName(name string) *UpdateConfigurationOptions
SetName : Allow user to set Name
func (*UpdateConfigurationOptions) SetXSmAcceptConfigurationType ¶
func (_options *UpdateConfigurationOptions) SetXSmAcceptConfigurationType(xSmAcceptConfigurationType string) *UpdateConfigurationOptions
SetXSmAcceptConfigurationType : Allow user to set XSmAcceptConfigurationType
type UpdateSecretGroupOptions ¶
type UpdateSecretGroupOptions struct {
// The v4 UUID that uniquely identifies your secret group.
ID *string `json:"id" validate:"required,ne="`
// The request body to update a secret group.
SecretGroupPatch map[string]interface{} `json:"SecretGroupPatch" validate:"required"`
// Allows users to set headers on API requests
Headers map[string]string
}
UpdateSecretGroupOptions : The UpdateSecretGroup options.
func (*UpdateSecretGroupOptions) SetHeaders ¶
func (options *UpdateSecretGroupOptions) SetHeaders(param map[string]string) *UpdateSecretGroupOptions
SetHeaders : Allow user to set Headers
func (*UpdateSecretGroupOptions) SetID ¶
func (_options *UpdateSecretGroupOptions) SetID(id string) *UpdateSecretGroupOptions
SetID : Allow user to set ID
func (*UpdateSecretGroupOptions) SetSecretGroupPatch ¶
func (_options *UpdateSecretGroupOptions) SetSecretGroupPatch(secretGroupPatch map[string]interface{}) *UpdateSecretGroupOptions
SetSecretGroupPatch : Allow user to set SecretGroupPatch
type UpdateSecretMetadataOptions ¶
type UpdateSecretMetadataOptions struct {
// The v4 UUID that uniquely identifies your secret.
ID *string `json:"id" validate:"required,ne="`
// JSON Merge-Patch content for update_secret_metadata.
SecretMetadataPatch map[string]interface{} `json:"SecretMetadataPatch" 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 ¶
func (_options *UpdateSecretMetadataOptions) SetID(id string) *UpdateSecretMetadataOptions
SetID : Allow user to set ID
func (*UpdateSecretMetadataOptions) SetSecretMetadataPatch ¶
func (_options *UpdateSecretMetadataOptions) SetSecretMetadataPatch(secretMetadataPatch map[string]interface{}) *UpdateSecretMetadataOptions
SetSecretMetadataPatch : Allow user to set SecretMetadataPatch
type UpdateSecretVersionMetadataOptions ¶
type UpdateSecretVersionMetadataOptions struct {
// The v4 UUID that uniquely identifies your secret.
SecretID *string `json:"secret_id" validate:"required,ne="`
// The v4 UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer
// to the current or previous secret version.
ID *string `json:"id" validate:"required,ne="`
// JSON Merge-Patch content for update_secret_version_metadata.
SecretVersionMetadataPatch map[string]interface{} `json:"SecretVersionMetadataPatch" validate:"required"`
// Allows users to set headers on API requests
Headers map[string]string
}
UpdateSecretVersionMetadataOptions : The UpdateSecretVersionMetadata options.
func (*UpdateSecretVersionMetadataOptions) SetHeaders ¶
func (options *UpdateSecretVersionMetadataOptions) SetHeaders(param map[string]string) *UpdateSecretVersionMetadataOptions
SetHeaders : Allow user to set Headers
func (*UpdateSecretVersionMetadataOptions) SetID ¶
func (_options *UpdateSecretVersionMetadataOptions) SetID(id string) *UpdateSecretVersionMetadataOptions
SetID : Allow user to set ID
func (*UpdateSecretVersionMetadataOptions) SetSecretID ¶
func (_options *UpdateSecretVersionMetadataOptions) SetSecretID(secretID string) *UpdateSecretVersionMetadataOptions
SetSecretID : Allow user to set SecretID
func (*UpdateSecretVersionMetadataOptions) SetSecretVersionMetadataPatch ¶
func (_options *UpdateSecretVersionMetadataOptions) SetSecretVersionMetadataPatch(secretVersionMetadataPatch map[string]interface{}) *UpdateSecretVersionMetadataOptions
SetSecretVersionMetadataPatch : Allow user to set SecretVersionMetadataPatch
type UsernamePasswordSecret ¶
type UsernamePasswordSecret struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported 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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// Policy for auto-generated passwords.
PasswordGenerationPolicy *PasswordGenerationPolicyRO `json:"password_generation_policy,omitempty"`
// The username that is assigned to an `username_password` secret.
Username *string `json:"username" validate:"required"`
// The password that is assigned to an `username_password` secret.
Password *string `json:"password" validate:"required"`
}
UsernamePasswordSecret : Your user credentials secret. This model "extends" Secret
type UsernamePasswordSecretMetadata ¶
type UsernamePasswordSecretMetadata struct {
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// A CRN that uniquely identifies an IBM Cloud resource.
Crn *string `json:"crn" validate:"required"`
// The secret metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,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
// group.
Description *string `json:"description,omitempty"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 number of locks of the secret.
LocksTotal *int64 `json:"locks_total,omitempty"`
// The human-readable name of your secret.
Name *string `json:"name,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`,
// `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.
State *int64 `json:"state,omitempty"`
// A text representation of the secret state.
StateDescription *string `json:"state_description,omitempty"`
// The date when a resource was modified. The date format follows `RFC 3339`.
UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
// The number of versions of your secret.
VersionsTotal *int64 `json:"versions_total" validate:"required"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation" validate:"required"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported 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 an existing rotation policy.
NextRotationDate *strfmt.DateTime `json:"next_rotation_date,omitempty"`
// Policy for auto-generated passwords.
PasswordGenerationPolicy *PasswordGenerationPolicyRO `json:"password_generation_policy,omitempty"`
}
UsernamePasswordSecretMetadata : Properties of the metadata of your user credentials secret. This model "extends" SecretMetadata
type UsernamePasswordSecretMetadataPatch ¶
type UsernamePasswordSecretMetadataPatch struct {
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 metadata that a user can customize.
CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,omitempty"`
// Policy patch for auto-generated passwords. Policy properties that are included in the patch are updated.
// Properties that are not included in the patch remain unchanged.
PasswordGenerationPolicy *PasswordGenerationPolicyPatch `json:"password_generation_policy,omitempty"`
}
UsernamePasswordSecretMetadataPatch : UsernamePasswordSecretMetadataPatch struct This model "extends" SecretMetadataPatch
func (*UsernamePasswordSecretMetadataPatch) AsPatch ¶
func (usernamePasswordSecretMetadataPatch *UsernamePasswordSecretMetadataPatch) AsPatch() (_patch map[string]interface{}, err error)
AsPatch returns a generic map representation of the UsernamePasswordSecretMetadataPatch
type UsernamePasswordSecretPrototype ¶
type UsernamePasswordSecretPrototype struct {
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A human-readable name to assign to your secret.
//
// To protect your privacy, do not use personal data, such as your name or location, as a name 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
// group.
Description *string `json:"description,omitempty"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id,omitempty"`
// Labels that you can use to search secrets in your instance. Only 30 labels can be created.
//
// Label can be between 2-64 characters, including spaces.
//
// 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 username that is assigned to an `username_password` secret.
Username *string `json:"username" validate:"required"`
// The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager
// generates a new random password for your secret.
Password *string `json:"password,omitempty"`
// The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types:
// Arbitrary, username_password.
ExpirationDate *strfmt.DateTime `json:"expiration_date,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"`
// This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types:
// username_password, private_cert, public_cert, iam_credentials.
Rotation RotationPolicyIntf `json:"rotation,omitempty"`
// Policy for auto-generated passwords.
PasswordGenerationPolicy *PasswordGenerationPolicy `json:"password_generation_policy,omitempty"`
}
UsernamePasswordSecretPrototype : UsernamePasswordSecretPrototype struct This model "extends" SecretPrototype
type UsernamePasswordSecretVersion ¶
type UsernamePasswordSecretVersion struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
// The username that is assigned to an `username_password` secret.
Username *string `json:"username" validate:"required"`
// The password that is assigned to an `username_password` secret.
Password *string `json:"password" validate:"required"`
}
UsernamePasswordSecretVersion : Your user credentials secret version. This model "extends" SecretVersion
type UsernamePasswordSecretVersionMetadata ¶
type UsernamePasswordSecretVersionMetadata struct {
// Indicates whether the version of the secret was created by automatic rotation.
AutoRotated *bool `json:"auto_rotated,omitempty"`
// The unique identifier that is associated with the entity that created the secret.
CreatedBy *string `json:"created_by" validate:"required"`
// The date when the resource was created. The date format follows `RFC 3339`.
CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
// This field 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"`
// A v4 UUID identifier.
ID *string `json:"id" validate:"required"`
// The human-readable name of your secret.
SecretName *string `json:"secret_name,omitempty"`
// The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials,
// service_credentials, kv, and username_password.
SecretType *string `json:"secret_type" validate:"required"`
// A v4 UUID identifier, or `default` secret group.
SecretGroupID *string `json:"secret_group_id" validate:"required"`
// Indicates whether the secret payload is available in this secret version.
PayloadAvailable *bool `json:"payload_available" validate:"required"`
// 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 secret version metadata that a user can customize.
VersionCustomMetadata map[string]interface{} `json:"version_custom_metadata,omitempty"`
// A v4 UUID identifier.
SecretID *string `json:"secret_id" validate:"required"`
}
UsernamePasswordSecretVersionMetadata : Properties of the version metadata of your user credentials secret. This model "extends" SecretVersionMetadata
type UsernamePasswordSecretVersionPrototype ¶
type UsernamePasswordSecretVersionPrototype struct {
// The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager
// generates a new random password for your secret.
Password *string `json:"password,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"`
}
UsernamePasswordSecretVersionPrototype : UsernamePasswordSecretVersionPrototype struct This model "extends" SecretVersionPrototype
type VersionAction ¶
type VersionAction struct {
// The type of secret version action.
ActionType *string `json:"action_type,omitempty"`
// The timestamp of the certificate revocation.
RevocationTimeSeconds *int64 `json:"revocation_time_seconds,omitempty"`
}
VersionAction : The request body to specify the properties of the action to create a secret version. Models which "extend" this model: - PrivateCertificateVersionActionRevoke
type VersionActionIntf ¶
type VersionActionIntf interface {
// contains filtered or unexported methods
}
Source Files
Click to show internal directories.
Click to hide internal directories.