SecretGenerationContext

class oci.vault.models.SecretGenerationContext(**kwargs)

Bases: object

Captures a configurable set of secret generation rules such as length, base characters, additional characters, and so on.

Attributes

GENERATION_TYPE_BYTES A constant which can be used with the generation_type property of a SecretGenerationContext.
GENERATION_TYPE_PASSPHRASE A constant which can be used with the generation_type property of a SecretGenerationContext.
GENERATION_TYPE_SSH_KEY A constant which can be used with the generation_type property of a SecretGenerationContext.
generation_type [Required] Gets the generation_type of this SecretGenerationContext.
secret_template Gets the secret_template of this SecretGenerationContext.

Methods

__init__(**kwargs) Initializes a new SecretGenerationContext object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
GENERATION_TYPE_BYTES = 'BYTES'

A constant which can be used with the generation_type property of a SecretGenerationContext. This constant has a value of “BYTES”

GENERATION_TYPE_PASSPHRASE = 'PASSPHRASE'

A constant which can be used with the generation_type property of a SecretGenerationContext. This constant has a value of “PASSPHRASE”

GENERATION_TYPE_SSH_KEY = 'SSH_KEY'

A constant which can be used with the generation_type property of a SecretGenerationContext. This constant has a value of “SSH_KEY”

__init__(**kwargs)

Initializes a new SecretGenerationContext object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • generation_type (str) – The value to assign to the generation_type property of this SecretGenerationContext. Allowed values for this property are: “PASSPHRASE”, “SSH_KEY”, “BYTES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • secret_template (str) – The value to assign to the secret_template property of this SecretGenerationContext.
generation_type

[Required] Gets the generation_type of this SecretGenerationContext. Name of the predefined secret generation type.

Allowed values for this property are: “PASSPHRASE”, “SSH_KEY”, “BYTES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The generation_type of this SecretGenerationContext.
Return type:str
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

secret_template

Gets the secret_template of this SecretGenerationContext. SecretTemplate captures structure in which customer wants to store secrets. This is optional and a default structure is available for each secret type. The template can have any structure with static values that are not generated. Within the template, you can insert predefined placeholders to store secrets. These placeholders are later replaced with the generated content and saved as a Base64 encoded content.

Returns:The secret_template of this SecretGenerationContext.
Return type:str