secretsmanagerv1

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

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

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

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

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

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

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

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

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

	// An extended description of your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for your secret.
	Description *string `json:"description,omitempty"`

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

	// The secret state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1,
	// Suspended = 2, Deactivated = 3, and Destroyed = 5 values.
	State *int64 `json:"state,omitempty"`

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

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

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

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

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

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

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

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

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

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

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

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

	// An extended description of your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for your secret.
	Description *string `json:"description,omitempty"`

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

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

	// The secret state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1,
	// Suspended = 2, Deactivated = 3, and Destroyed = 5 values.
	State *int64 `json:"state,omitempty"`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// An extended description of your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for your secret.
	Description *string `json:"description,omitempty"`

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

	// The secret state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1,
	// Suspended = 2, Deactivated = 3, and Destroyed = 5 values.
	State *int64 `json:"state,omitempty"`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// An extended description of your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for your secret.
	Description *string `json:"description,omitempty"`

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

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

	// The secret state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1,
	// Suspended = 2, Deactivated = 3, and Destroyed = 5 values.
	State *int64 `json:"state,omitempty"`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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"`
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

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

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

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

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

type CreateIamCredentialsSecretEngineRootConfig struct {
	// An IBM Cloud API key that can create and manage service IDs.
	//
	// The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on
	// the IAM Identity Service. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
	APIKey *string `json:"api_key" validate:"required"`

	// The hash value of the IBM Cloud API key that is used to create and manage service IDs.
	APIKeyHash *string `json:"api_key_hash,omitempty"`
}

type CreateNotificationsRegistrationOptions struct {
	// The Cloud Resource Name (CRN) of the connected Event Notifications instance.
	EventNotificationsInstanceCRN *string `json:"event_notifications_instance_crn" validate:"required"`

	// The name that is displayed as a source in your Event Notifications instance.
	EventNotificationsSourceName *string `json:"event_notifications_source_name" validate:"required"`

	// An optional description for the source in your Event Notifications instance.
	EventNotificationsSourceDescription *string `json:"event_notifications_source_description,omitempty"`

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

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

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

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

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

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

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

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

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

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

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

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

	// The name of your configuration.
	ConfigName *string `json:"config_name" validate:"required,ne="`

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

type DeleteCredentialsForIamCredentialsSecret struct {
	// The ID of the API key that you want to delete. If the secret was created with a static service ID, only the API key
	// is deleted. Otherwise, the service ID is deleted together with its API key.
	APIKeyID *string `json:"api_key_id,omitempty"`

	// The service ID that you want to delete. This property can be used instead of the `api_key_id` field, but only for
	// secrets that were created with a service ID that was generated by Secrets Manager.
	//
	// **Deprecated.** Use the `api_key_id` field instead.
	// Deprecated: this field is deprecated and may be removed in a future release.
	ServiceID *string `json:"service_id,omitempty"`
}

type DeleteNotificationsRegistrationOptions struct {

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

type DeleteSecretGroupOptions struct {
	// The v4 UUID that uniquely identifies the secret group.
	ID *string `json:"id" validate:"required,ne="`

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

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

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

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

type EngineConfig struct {
	// An IBM Cloud API key that can create and manage service IDs.
	//
	// The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on
	// the IAM Identity Service. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
	APIKey *string `json:"api_key,omitempty"`

	// The hash value of the IBM Cloud API key that is used to create and manage service IDs.
	APIKeyHash *string `json:"api_key_hash,omitempty"`
}

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

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

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

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

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

	// The name of your configuration.
	ConfigName *string `json:"config_name" validate:"required,ne="`

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

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

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

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

	// The configuration element to define or manage.
	ConfigElement *string `json:"config_element" validate:"required,ne="`

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

type GetConfigElementsResourcesItem struct {
	CertificateAuthorities []ConfigElementMetadata `json:"certificate_authorities,omitempty"`

	DNSProviders []ConfigElementMetadata `json:"dns_providers,omitempty"`

	RootCertificateAuthorities []RootCertificateAuthoritiesConfigItem `json:"root_certificate_authorities,omitempty"`

	IntermediateCertificateAuthorities []IntermediateCertificateAuthoritiesConfigItem `json:"intermediate_certificate_authorities,omitempty"`

	CertificateTemplates []CertificateTemplatesConfigItem `json:"certificate_templates,omitempty"`
}

type GetConfigElementsResourcesItemCertificateAuthoritiesConfig struct {
	CertificateAuthorities []ConfigElementMetadata `json:"certificate_authorities" validate:"required"`
}

type GetConfigElementsResourcesItemDNSProvidersConfig struct {
	DNSProviders []ConfigElementMetadata `json:"dns_providers" validate:"required"`
}

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

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

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

type GetConfigResourcesItem struct {
	// The certificate authority configurations that are associated with your instance.
	CertificateAuthorities []ConfigElementMetadata `json:"certificate_authorities,omitempty"`

	// The DNS provider configurations that are associated with your instance.
	DNSProviders []ConfigElementMetadata `json:"dns_providers,omitempty"`

	// The root certificate authority configurations that are associated with your instance.
	RootCertificateAuthorities []RootCertificateAuthoritiesConfigItem `json:"root_certificate_authorities,omitempty"`

	// The intermediate certificate authority configurations that are associated with your instance.
	IntermediateCertificateAuthorities []IntermediateCertificateAuthoritiesConfigItem `json:"intermediate_certificate_authorities,omitempty"`

	// The certificate templates that are associated with your instance.
	CertificateTemplates []CertificateTemplatesConfigItem `json:"certificate_templates,omitempty"`

	// An IBM Cloud API key that can create and manage service IDs.
	//
	// The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on
	// the IAM Identity Service. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
	APIKey *string `json:"api_key,omitempty"`

	// The hash value of the IBM Cloud API key that is used to create and manage service IDs.
	APIKeyHash *string `json:"api_key_hash,omitempty"`
}

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

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

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

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

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The number of locks to retrieve. By default, list operations return the first 25 items. To retrieve a different set
	// of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 locks associated with your secret, and you want to retrieve only the first 5 locks, use
	// `..?limit=5`.
	Limit *int64 `json:"limit,omitempty"`

	// The number of locks to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`
	// value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 locks on your secret, and you want to retrieve locks 26 through 50, use
	// `..?offset=25&limit=25`.
	Offset *int64 `json:"offset,omitempty"`

	// Filter locks that contain the specified string in the field "name".
	//
	// **Usage:** If you want to list only the locks that contain the string "text" in the field "name", use
	// `..?search=text`.
	Search *string `json:"search,omitempty"`

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

type GetNotificationsRegistrationOptions struct {

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

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

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

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

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The type of policy that is associated with the specified secret.
	Policy *string `json:"policy,omitempty"`

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

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

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

type GetSecretGroupOptions struct {
	// The v4 UUID that uniquely identifies the secret group.
	ID *string `json:"id" validate:"required,ne="`

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

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

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

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

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

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

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

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

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

type GetSecretPolicies struct {
	// The metadata that describes the resource array.
	Metadata *CollectionMetadata `json:"metadata,omitempty"`

	// A collection of resources.
	Resources []map[string]interface{} `json:"resources,omitempty"`
}

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

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

	// A collection of resources.
	Resources []map[string]interface{} `json:"resources" validate:"required"`
}

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

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

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

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

	// The number of locks to retrieve. By default, list operations return the first 25 items. To retrieve a different set
	// of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 locks associated with your secret, and you want to retrieve only the first 5 locks, use
	// `..?limit=5`.
	Limit *int64 `json:"limit,omitempty"`

	// The number of locks to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`
	// value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 locks on your secret, and you want to retrieve locks 26 through 50, use
	// `..?offset=25&limit=25`.
	Offset *int64 `json:"offset,omitempty"`

	// Filter locks that contain the specified string in the field "name".
	//
	// **Usage:** If you want to list only the locks that contain the string "text" in the field "name", use
	// `..?search=text`.
	Search *string `json:"search,omitempty"`

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

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

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

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

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

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

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

	// The v4 UUID that uniquely identifies the secret.
	ID *string `json:"id" validate:"required,ne="`

	// The v4 UUID that uniquely identifies the secret version. You can also use `previous` to retrieve the previous
	// version.
	//
	// **Note:** To find the version ID of a secret, use the [Get secret metadata](#get-secret-metadata) method and check
	// the response details.
	VersionID *string `json:"version_id" validate:"required,ne="`

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

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

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

type IamCredentialsSecretEngineRootConfig struct {
	// An IBM Cloud API key that can create and manage service IDs.
	//
	// The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on
	// the IAM Identity Service. For more information, see the
	// [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).
	APIKey *string `json:"api_key" validate:"required"`

	// The hash value of the IBM Cloud API key that is used to create and manage service IDs.
	APIKeyHash *string `json:"api_key_hash,omitempty"`
}

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

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

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

	// An extended description of your secret.
	//
	// To protect your privacy, do not use personal data, such as your name or location, as a description for your secret.
	Description *string `json:"description,omitempty"`

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

	// The secret state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1,
	// Suspended = 2, Deactivated = 3, and Destroyed = 5 values.
	State *int64 `json:"state,omitempty"`

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

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

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

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

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

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

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

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

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

	// The time-to-live (TTL) or lease duration that is assigned to the secret. For `iam_credentials` secrets, the TTL
	// defines for how long each generated API key remains valid.
	TTL *string `json:"ttl,omitempty"`

	// Determines whether to use the same service ID and API key for future read operations on an
	// `iam_credentials` secret.
	//
	// If set to `true`, the service reuses the current credentials. If set to `false`, a new service ID and API key are
	// generated each time that the secret is read or accessed.
	ReuseAPIKey *bool `json:"reuse_api_key,omitempty"`

	// Indicates whether an `iam_credentials` secret was created with a static service ID.
	//
	// If the value is `true`, the service ID for the secret was provided by the user at secret creation. If the value is
	// `false`, the service ID was generated by Secrets Manager.
	ServiceIDIsStatic *bool `json:"service_id_is_static,omitempty"`

	// The service ID under which the API key is created. The service ID is included in the metadata only if the secret was
	// created with a static service ID.
	ServiceID *string `json:"service_id,omitempty"`

	// The access groups that define the capabilities of the service ID and API key that are generated for an
	// `iam_credentials` secret. The access groups are included in the metadata only if the secret was created with a
	// service ID that was generated by Secrets Manager.
	AccessGroups []string `json:"access_groups,omitempty"`
}