oci 2.122.0__py3-none-any.whl → 2.123.0__py3-none-any.whl

oci/vault/models/bytes_generation_context.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20180608
+
+from .secret_generation_context import SecretGenerationContext
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class BytesGenerationContext(SecretGenerationContext):
+    """
+    Generates random bytes. By default, secrets of type Bytes has no structure. The generated bytes are stored as a Base64 encoded string.
+    The SecretTemplate must have the %GENERATED_BYTES% keyword which is replaced with the generated bytes, if provided
+    """
+
+    #: A constant which can be used with the generation_template property of a BytesGenerationContext.
+    #: This constant has a value of "BYTES_512"
+    GENERATION_TEMPLATE_BYTES_512 = "BYTES_512"
+
+    #: A constant which can be used with the generation_template property of a BytesGenerationContext.
+    #: This constant has a value of "BYTES_1024"
+    GENERATION_TEMPLATE_BYTES_1024 = "BYTES_1024"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BytesGenerationContext object with values from keyword arguments. The default value of the :py:attr:`~oci.vault.models.BytesGenerationContext.generation_type` attribute
+        of this class is ``BYTES`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param generation_type:
+            The value to assign to the generation_type property of this BytesGenerationContext.
+            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'.
+        :type generation_type: str
+
+        :param secret_template:
+            The value to assign to the secret_template property of this BytesGenerationContext.
+        :type secret_template: str
+
+        :param generation_template:
+            The value to assign to the generation_template property of this BytesGenerationContext.
+            Allowed values for this property are: "BYTES_512", "BYTES_1024", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type generation_template: str
+
+        """
+        self.swagger_types = {
+            'generation_type': 'str',
+            'secret_template': 'str',
+            'generation_template': 'str'
+        }
+
+        self.attribute_map = {
+            'generation_type': 'generationType',
+            'secret_template': 'secretTemplate',
+            'generation_template': 'generationTemplate'
+        }
+
+        self._generation_type = None
+        self._secret_template = None
+        self._generation_template = None
+        self._generation_type = 'BYTES'
+
+    @property
+    def generation_template(self):
+        """
+        **[Required]** Gets the generation_template of this BytesGenerationContext.
+        Name of random bytes generation template for generating random byte type secret.
+
+        Allowed values for this property are: "BYTES_512", "BYTES_1024", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The generation_template of this BytesGenerationContext.
+        :rtype: str
+        """
+        return self._generation_template
+
+    @generation_template.setter
+    def generation_template(self, generation_template):
+        """
+        Sets the generation_template of this BytesGenerationContext.
+        Name of random bytes generation template for generating random byte type secret.
+
+
+        :param generation_template: The generation_template of this BytesGenerationContext.
+        :type: str
+        """
+        allowed_values = ["BYTES_512", "BYTES_1024"]
+        if not value_allowed_none_or_none_sentinel(generation_template, allowed_values):
+            generation_template = 'UNKNOWN_ENUM_VALUE'
+        self._generation_template = generation_template
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/vault/models/create_secret_details.py

@@ -64,6 +64,14 @@ class CreateSecretDetails(object):
             The value to assign to the vault_id property of this CreateSecretDetails.
         :type vault_id: str
 
+        :param secret_generation_context:
+            The value to assign to the secret_generation_context property of this CreateSecretDetails.
+        :type secret_generation_context: oci.vault.models.SecretGenerationContext
+
+        :param enable_auto_generation:
+            The value to assign to the enable_auto_generation property of this CreateSecretDetails.
+        :type enable_auto_generation: bool
+
         """
         self.swagger_types = {
             'compartment_id': 'str',
@@ -76,7 +84,9 @@ class CreateSecretDetails(object):
             'rotation_config': 'RotationConfig',
             'secret_name': 'str',
             'secret_rules': 'list[SecretRule]',
-            'vault_id': 'str'
+            'vault_id': 'str',
+            'secret_generation_context': 'SecretGenerationContext',
+            'enable_auto_generation': 'bool'
         }
 
         self.attribute_map = {
@@ -90,7 +100,9 @@ class CreateSecretDetails(object):
             'rotation_config': 'rotationConfig',
             'secret_name': 'secretName',
             'secret_rules': 'secretRules',
-            'vault_id': 'vaultId'
+            'vault_id': 'vaultId',
+            'secret_generation_context': 'secretGenerationContext',
+            'enable_auto_generation': 'enableAutoGeneration'
         }
 
         self._compartment_id = None
@@ -104,6 +116,8 @@ class CreateSecretDetails(object):
         self._secret_name = None
         self._secret_rules = None
         self._vault_id = None
+        self._secret_generation_context = None
+        self._enable_auto_generation = None
 
     @property
     def compartment_id(self):
@@ -220,7 +234,7 @@ class CreateSecretDetails(object):
     @property
     def key_id(self):
         """
-        Gets the key_id of this CreateSecretDetails.
+        **[Required]** Gets the key_id of this CreateSecretDetails.
         The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.
 
 
@@ -381,6 +395,50 @@ class CreateSecretDetails(object):
         """
         self._vault_id = vault_id
 
+    @property
+    def secret_generation_context(self):
+        """
+        Gets the secret_generation_context of this CreateSecretDetails.
+
+        :return: The secret_generation_context of this CreateSecretDetails.
+        :rtype: oci.vault.models.SecretGenerationContext
+        """
+        return self._secret_generation_context
+
+    @secret_generation_context.setter
+    def secret_generation_context(self, secret_generation_context):
+        """
+        Sets the secret_generation_context of this CreateSecretDetails.
+
+        :param secret_generation_context: The secret_generation_context of this CreateSecretDetails.
+        :type: oci.vault.models.SecretGenerationContext
+        """
+        self._secret_generation_context = secret_generation_context
+
+    @property
+    def enable_auto_generation(self):
+        """
+        Gets the enable_auto_generation of this CreateSecretDetails.
+        The value of this flag determines whether or not secret content will be generated automatically. If not set, it defaults to false.
+
+
+        :return: The enable_auto_generation of this CreateSecretDetails.
+        :rtype: bool
+        """
+        return self._enable_auto_generation
+
+    @enable_auto_generation.setter
+    def enable_auto_generation(self, enable_auto_generation):
+        """
+        Sets the enable_auto_generation of this CreateSecretDetails.
+        The value of this flag determines whether or not secret content will be generated automatically. If not set, it defaults to false.
+
+
+        :param enable_auto_generation: The enable_auto_generation of this CreateSecretDetails.
+        :type: bool
+        """
+        self._enable_auto_generation = enable_auto_generation
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/vault/models/passphrase_generation_context.py

@@ -0,0 +1,138 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20180608
+
+from .secret_generation_context import SecretGenerationContext
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class PassphraseGenerationContext(SecretGenerationContext):
+    """
+    Generates Passphrase type secrets. By default, passphrase type secrets have no structure. The generated content is stored in Base64 format.
+    The SecretTemplate must have the %GENERATED_PASSPHRASE% keyword, which is later replaced with the generated content, if provided.
+    """
+
+    #: A constant which can be used with the generation_template property of a PassphraseGenerationContext.
+    #: This constant has a value of "SECRETS_DEFAULT_PASSWORD"
+    GENERATION_TEMPLATE_SECRETS_DEFAULT_PASSWORD = "SECRETS_DEFAULT_PASSWORD"
+
+    #: A constant which can be used with the generation_template property of a PassphraseGenerationContext.
+    #: This constant has a value of "DBAAS_DEFAULT_PASSWORD"
+    GENERATION_TEMPLATE_DBAAS_DEFAULT_PASSWORD = "DBAAS_DEFAULT_PASSWORD"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PassphraseGenerationContext object with values from keyword arguments. The default value of the :py:attr:`~oci.vault.models.PassphraseGenerationContext.generation_type` attribute
+        of this class is ``PASSPHRASE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param generation_type:
+            The value to assign to the generation_type property of this PassphraseGenerationContext.
+            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'.
+        :type generation_type: str
+
+        :param secret_template:
+            The value to assign to the secret_template property of this PassphraseGenerationContext.
+        :type secret_template: str
+
+        :param generation_template:
+            The value to assign to the generation_template property of this PassphraseGenerationContext.
+            Allowed values for this property are: "SECRETS_DEFAULT_PASSWORD", "DBAAS_DEFAULT_PASSWORD", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type generation_template: str
+
+        :param passphrase_length:
+            The value to assign to the passphrase_length property of this PassphraseGenerationContext.
+        :type passphrase_length: int
+
+        """
+        self.swagger_types = {
+            'generation_type': 'str',
+            'secret_template': 'str',
+            'generation_template': 'str',
+            'passphrase_length': 'int'
+        }
+
+        self.attribute_map = {
+            'generation_type': 'generationType',
+            'secret_template': 'secretTemplate',
+            'generation_template': 'generationTemplate',
+            'passphrase_length': 'passphraseLength'
+        }
+
+        self._generation_type = None
+        self._secret_template = None
+        self._generation_template = None
+        self._passphrase_length = None
+        self._generation_type = 'PASSPHRASE'
+
+    @property
+    def generation_template(self):
+        """
+        **[Required]** Gets the generation_template of this PassphraseGenerationContext.
+        Name of passphrase generation template to generate passphrase type secret.
+
+        Allowed values for this property are: "SECRETS_DEFAULT_PASSWORD", "DBAAS_DEFAULT_PASSWORD", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The generation_template of this PassphraseGenerationContext.
+        :rtype: str
+        """
+        return self._generation_template
+
+    @generation_template.setter
+    def generation_template(self, generation_template):
+        """
+        Sets the generation_template of this PassphraseGenerationContext.
+        Name of passphrase generation template to generate passphrase type secret.
+
+
+        :param generation_template: The generation_template of this PassphraseGenerationContext.
+        :type: str
+        """
+        allowed_values = ["SECRETS_DEFAULT_PASSWORD", "DBAAS_DEFAULT_PASSWORD"]
+        if not value_allowed_none_or_none_sentinel(generation_template, allowed_values):
+            generation_template = 'UNKNOWN_ENUM_VALUE'
+        self._generation_template = generation_template
+
+    @property
+    def passphrase_length(self):
+        """
+        Gets the passphrase_length of this PassphraseGenerationContext.
+        Length of the passphrase to be generated
+
+
+        :return: The passphrase_length of this PassphraseGenerationContext.
+        :rtype: int
+        """
+        return self._passphrase_length
+
+    @passphrase_length.setter
+    def passphrase_length(self, passphrase_length):
+        """
+        Sets the passphrase_length of this PassphraseGenerationContext.
+        Length of the passphrase to be generated
+
+
+        :param passphrase_length: The passphrase_length of this PassphraseGenerationContext.
+        :type: int
+        """
+        self._passphrase_length = passphrase_length
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/vault/models/secret.py

@@ -156,6 +156,14 @@ class Secret(object):
             The value to assign to the vault_id property of this Secret.
         :type vault_id: str
 
+        :param secret_generation_context:
+            The value to assign to the secret_generation_context property of this Secret.
+        :type secret_generation_context: oci.vault.models.SecretGenerationContext
+
+        :param is_auto_generation_enabled:
+            The value to assign to the is_auto_generation_enabled property of this Secret.
+        :type is_auto_generation_enabled: bool
+
         """
         self.swagger_types = {
             'compartment_id': 'str',
@@ -177,7 +185,9 @@ class Secret(object):
             'time_created': 'datetime',
             'time_of_current_version_expiry': 'datetime',
             'time_of_deletion': 'datetime',
-            'vault_id': 'str'
+            'vault_id': 'str',
+            'secret_generation_context': 'SecretGenerationContext',
+            'is_auto_generation_enabled': 'bool'
         }
 
         self.attribute_map = {
@@ -200,7 +210,9 @@ class Secret(object):
             'time_created': 'timeCreated',
             'time_of_current_version_expiry': 'timeOfCurrentVersionExpiry',
             'time_of_deletion': 'timeOfDeletion',
-            'vault_id': 'vaultId'
+            'vault_id': 'vaultId',
+            'secret_generation_context': 'secretGenerationContext',
+            'is_auto_generation_enabled': 'isAutoGenerationEnabled'
         }
 
         self._compartment_id = None
@@ -223,6 +235,8 @@ class Secret(object):
         self._time_of_current_version_expiry = None
         self._time_of_deletion = None
         self._vault_id = None
+        self._secret_generation_context = None
+        self._is_auto_generation_enabled = None
 
     @property
     def compartment_id(self):
@@ -762,6 +776,50 @@ class Secret(object):
         """
         self._vault_id = vault_id
 
+    @property
+    def secret_generation_context(self):
+        """
+        Gets the secret_generation_context of this Secret.
+
+        :return: The secret_generation_context of this Secret.
+        :rtype: oci.vault.models.SecretGenerationContext
+        """
+        return self._secret_generation_context
+
+    @secret_generation_context.setter
+    def secret_generation_context(self, secret_generation_context):
+        """
+        Sets the secret_generation_context of this Secret.
+
+        :param secret_generation_context: The secret_generation_context of this Secret.
+        :type: oci.vault.models.SecretGenerationContext
+        """
+        self._secret_generation_context = secret_generation_context
+
+    @property
+    def is_auto_generation_enabled(self):
+        """
+        Gets the is_auto_generation_enabled of this Secret.
+        The value of this flag determines whether or not secret content will be generated automatically.
+
+
+        :return: The is_auto_generation_enabled of this Secret.
+        :rtype: bool
+        """
+        return self._is_auto_generation_enabled
+
+    @is_auto_generation_enabled.setter
+    def is_auto_generation_enabled(self, is_auto_generation_enabled):
+        """
+        Sets the is_auto_generation_enabled of this Secret.
+        The value of this flag determines whether or not secret content will be generated automatically.
+
+
+        :param is_auto_generation_enabled: The is_auto_generation_enabled of this Secret.
+        :type: bool
+        """
+        self._is_auto_generation_enabled = is_auto_generation_enabled
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/vault/models/secret_generation_context.py

@@ -0,0 +1,152 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20180608
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class SecretGenerationContext(object):
+    """
+    Captures a configurable set of secret generation rules such as length, base characters, additional characters, and so on.
+    """
+
+    #: A constant which can be used with the generation_type property of a SecretGenerationContext.
+    #: This constant has a value of "PASSPHRASE"
+    GENERATION_TYPE_PASSPHRASE = "PASSPHRASE"
+
+    #: A constant which can be used with the generation_type property of a SecretGenerationContext.
+    #: This constant has a value of "SSH_KEY"
+    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 "BYTES"
+    GENERATION_TYPE_BYTES = "BYTES"
+
+    def __init__(self, **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:
+
+        * :class:`~oci.vault.models.PassphraseGenerationContext`
+        * :class:`~oci.vault.models.SshKeyGenerationContext`
+        * :class:`~oci.vault.models.BytesGenerationContext`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param generation_type:
+            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'.
+        :type generation_type: str
+
+        :param secret_template:
+            The value to assign to the secret_template property of this SecretGenerationContext.
+        :type secret_template: str
+
+        """
+        self.swagger_types = {
+            'generation_type': 'str',
+            'secret_template': 'str'
+        }
+
+        self.attribute_map = {
+            'generation_type': 'generationType',
+            'secret_template': 'secretTemplate'
+        }
+
+        self._generation_type = None
+        self._secret_template = None
+
+    @staticmethod
+    def 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.
+        """
+        type = object_dictionary['generationType']
+
+        if type == 'PASSPHRASE':
+            return 'PassphraseGenerationContext'
+
+        if type == 'SSH_KEY':
+            return 'SshKeyGenerationContext'
+
+        if type == 'BYTES':
+            return 'BytesGenerationContext'
+        else:
+            return 'SecretGenerationContext'
+
+    @property
+    def generation_type(self):
+        """
+        **[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'.
+
+
+        :return: The generation_type of this SecretGenerationContext.
+        :rtype: str
+        """
+        return self._generation_type
+
+    @generation_type.setter
+    def generation_type(self, generation_type):
+        """
+        Sets the generation_type of this SecretGenerationContext.
+        Name of the predefined secret generation type.
+
+
+        :param generation_type: The generation_type of this SecretGenerationContext.
+        :type: str
+        """
+        allowed_values = ["PASSPHRASE", "SSH_KEY", "BYTES"]
+        if not value_allowed_none_or_none_sentinel(generation_type, allowed_values):
+            generation_type = 'UNKNOWN_ENUM_VALUE'
+        self._generation_type = generation_type
+
+    @property
+    def secret_template(self):
+        """
+        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.
+
+
+        :return: The secret_template of this SecretGenerationContext.
+        :rtype: str
+        """
+        return self._secret_template
+
+    @secret_template.setter
+    def secret_template(self, secret_template):
+        """
+        Sets 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.
+
+
+        :param secret_template: The secret_template of this SecretGenerationContext.
+        :type: str
+        """
+        self._secret_template = secret_template
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other