akeyless 5.0.38 → 5.0.39

data/lib/akeyless/models/rotated_secret_create_okta.rb

@@ -0,0 +1,556 @@
+=begin
+#Akeyless API
+
+#The purpose of this application is to provide access to Akeyless API.
+
+The version of the OpenAPI document: 3.0
+Contact: support@akeyless.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Akeyless
+  class RotatedSecretCreateOkta
+    # Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs.  AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag.
+    attr_accessor :ara_enabled
+
+    # Okta uses the SSWS token from the target.
+    attr_accessor :authentication_credentials
+
+    attr_accessor :auto_rotate
+
+    # Protection from accidental deletion of this object [true/false]
+    attr_accessor :delete_protection
+
+    # Description of the object.
+    attr_accessor :description
+
+    # EnableAra is the documented spelling of AraEnabled. Both set the same field; --ara-enabled shipped first and stays as an undocumented alias so existing scripts and the Terraform provider keep working.
+    attr_accessor :enable_agentic_runtime_authority
+
+    # Turns on AI Quorum checks for this item.
+    attr_accessor :enable_ai_quorum
+
+    # Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)
+    attr_accessor :input_rule
+
+    # Additional custom fields to associate with the item
+    attr_accessor :item_custom_fields
+
+    # Set output format to JSON
+    attr_accessor :json
+
+    attr_accessor :key
+
+    # Lock this secret after each successful value read
+    attr_accessor :lock_on_read
+
+    # Lock TTL in minutes
+    attr_accessor :lock_ttl
+
+    # Set the maximum number of versions, limited by the account settings defaults.
+    attr_accessor :max_versions
+
+    # Rotated secret name
+    attr_accessor :name
+
+    # Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)
+    attr_accessor :output_rule
+
+    # The length of the password to be generated
+    attr_accessor :password_length
+
+    # Rotate this secret after it is unlocked
+    attr_accessor :rotate_on_unlock
+
+    # rotated-username password (relevant only for rotator-type=password)
+    attr_accessor :rotated_password
+
+    # username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
+    attr_accessor :rotated_username
+
+    # How many days before the rotation of the item would you like to be notified
+    attr_accessor :rotation_event_in
+
+    attr_accessor :rotation_hour
+
+    attr_accessor :rotation_interval
+
+    # The Okta rotator supports only password.
+    attr_accessor :rotator_type
+
+    # If set, dry-run will be skipped [true/false]
+    attr_accessor :skip_dry_run
+
+    # Add tags attached to this object
+    attr_accessor :tags
+
+    # The Okta target name to associate.
+    attr_accessor :target_name
+
+    # Authentication token (see `/auth` and `/configure`)
+    attr_accessor :token
+
+    # The universal identity token, Required only for universal_identity authentication
+    attr_accessor :uid_token
+
+    # Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false]
+    attr_accessor :use_capital_letters
+
+    # Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false]
+    attr_accessor :use_lower_letters
+
+    # Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false]
+    attr_accessor :use_numbers
+
+    attr_accessor :use_special_characters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ara_enabled' => :'ara-enabled',
+        :'authentication_credentials' => :'authentication-credentials',
+        :'auto_rotate' => :'auto-rotate',
+        :'delete_protection' => :'delete_protection',
+        :'description' => :'description',
+        :'enable_agentic_runtime_authority' => :'enable-agentic-runtime-authority',
+        :'enable_ai_quorum' => :'enable-ai-quorum',
+        :'input_rule' => :'input-rule',
+        :'item_custom_fields' => :'item-custom-fields',
+        :'json' => :'json',
+        :'key' => :'key',
+        :'lock_on_read' => :'lock-on-read',
+        :'lock_ttl' => :'lock-ttl',
+        :'max_versions' => :'max-versions',
+        :'name' => :'name',
+        :'output_rule' => :'output-rule',
+        :'password_length' => :'password-length',
+        :'rotate_on_unlock' => :'rotate-on-unlock',
+        :'rotated_password' => :'rotated-password',
+        :'rotated_username' => :'rotated-username',
+        :'rotation_event_in' => :'rotation-event-in',
+        :'rotation_hour' => :'rotation-hour',
+        :'rotation_interval' => :'rotation-interval',
+        :'rotator_type' => :'rotator-type',
+        :'skip_dry_run' => :'skip-dry-run',
+        :'tags' => :'tags',
+        :'target_name' => :'target-name',
+        :'token' => :'token',
+        :'uid_token' => :'uid-token',
+        :'use_capital_letters' => :'use-capital-letters',
+        :'use_lower_letters' => :'use-lower-letters',
+        :'use_numbers' => :'use-numbers',
+        :'use_special_characters' => :'use-special-characters'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ara_enabled' => :'Boolean',
+        :'authentication_credentials' => :'String',
+        :'auto_rotate' => :'String',
+        :'delete_protection' => :'String',
+        :'description' => :'String',
+        :'enable_agentic_runtime_authority' => :'Boolean',
+        :'enable_ai_quorum' => :'Boolean',
+        :'input_rule' => :'Array<String>',
+        :'item_custom_fields' => :'Hash<String, String>',
+        :'json' => :'Boolean',
+        :'key' => :'String',
+        :'lock_on_read' => :'String',
+        :'lock_ttl' => :'String',
+        :'max_versions' => :'String',
+        :'name' => :'String',
+        :'output_rule' => :'Array<String>',
+        :'password_length' => :'String',
+        :'rotate_on_unlock' => :'String',
+        :'rotated_password' => :'String',
+        :'rotated_username' => :'String',
+        :'rotation_event_in' => :'Array<String>',
+        :'rotation_hour' => :'Integer',
+        :'rotation_interval' => :'String',
+        :'rotator_type' => :'String',
+        :'skip_dry_run' => :'Boolean',
+        :'tags' => :'Array<String>',
+        :'target_name' => :'String',
+        :'token' => :'String',
+        :'uid_token' => :'String',
+        :'use_capital_letters' => :'String',
+        :'use_lower_letters' => :'String',
+        :'use_numbers' => :'String',
+        :'use_special_characters' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::RotatedSecretCreateOkta` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::RotatedSecretCreateOkta`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'ara_enabled')
+        self.ara_enabled = attributes[:'ara_enabled']
+      end
+
+      if attributes.key?(:'authentication_credentials')
+        self.authentication_credentials = attributes[:'authentication_credentials']
+      end
+
+      if attributes.key?(:'auto_rotate')
+        self.auto_rotate = attributes[:'auto_rotate']
+      end
+
+      if attributes.key?(:'delete_protection')
+        self.delete_protection = attributes[:'delete_protection']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'enable_agentic_runtime_authority')
+        self.enable_agentic_runtime_authority = attributes[:'enable_agentic_runtime_authority']
+      end
+
+      if attributes.key?(:'enable_ai_quorum')
+        self.enable_ai_quorum = attributes[:'enable_ai_quorum']
+      end
+
+      if attributes.key?(:'input_rule')
+        if (value = attributes[:'input_rule']).is_a?(Array)
+          self.input_rule = value
+        end
+      end
+
+      if attributes.key?(:'item_custom_fields')
+        if (value = attributes[:'item_custom_fields']).is_a?(Hash)
+          self.item_custom_fields = value
+        end
+      end
+
+      if attributes.key?(:'json')
+        self.json = attributes[:'json']
+      else
+        self.json = false
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      end
+
+      if attributes.key?(:'lock_on_read')
+        self.lock_on_read = attributes[:'lock_on_read']
+      end
+
+      if attributes.key?(:'lock_ttl')
+        self.lock_ttl = attributes[:'lock_ttl']
+      end
+
+      if attributes.key?(:'max_versions')
+        self.max_versions = attributes[:'max_versions']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'output_rule')
+        if (value = attributes[:'output_rule']).is_a?(Array)
+          self.output_rule = value
+        end
+      end
+
+      if attributes.key?(:'password_length')
+        self.password_length = attributes[:'password_length']
+      end
+
+      if attributes.key?(:'rotate_on_unlock')
+        self.rotate_on_unlock = attributes[:'rotate_on_unlock']
+      end
+
+      if attributes.key?(:'rotated_password')
+        self.rotated_password = attributes[:'rotated_password']
+      end
+
+      if attributes.key?(:'rotated_username')
+        self.rotated_username = attributes[:'rotated_username']
+      end
+
+      if attributes.key?(:'rotation_event_in')
+        if (value = attributes[:'rotation_event_in']).is_a?(Array)
+          self.rotation_event_in = value
+        end
+      end
+
+      if attributes.key?(:'rotation_hour')
+        self.rotation_hour = attributes[:'rotation_hour']
+      end
+
+      if attributes.key?(:'rotation_interval')
+        self.rotation_interval = attributes[:'rotation_interval']
+      end
+
+      if attributes.key?(:'rotator_type')
+        self.rotator_type = attributes[:'rotator_type']
+      end
+
+      if attributes.key?(:'skip_dry_run')
+        self.skip_dry_run = attributes[:'skip_dry_run']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'target_name')
+        self.target_name = attributes[:'target_name']
+      else
+        self.target_name = nil
+      end
+
+      if attributes.key?(:'token')
+        self.token = attributes[:'token']
+      end
+
+      if attributes.key?(:'uid_token')
+        self.uid_token = attributes[:'uid_token']
+      end
+
+      if attributes.key?(:'use_capital_letters')
+        self.use_capital_letters = attributes[:'use_capital_letters']
+      end
+
+      if attributes.key?(:'use_lower_letters')
+        self.use_lower_letters = attributes[:'use_lower_letters']
+      end
+
+      if attributes.key?(:'use_numbers')
+        self.use_numbers = attributes[:'use_numbers']
+      end
+
+      if attributes.key?(:'use_special_characters')
+        self.use_special_characters = attributes[:'use_special_characters']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @target_name.nil?
+        invalid_properties.push('invalid value for "target_name", target_name cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @name.nil?
+      return false if @target_name.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          ara_enabled == o.ara_enabled &&
+          authentication_credentials == o.authentication_credentials &&
+          auto_rotate == o.auto_rotate &&
+          delete_protection == o.delete_protection &&
+          description == o.description &&
+          enable_agentic_runtime_authority == o.enable_agentic_runtime_authority &&
+          enable_ai_quorum == o.enable_ai_quorum &&
+          input_rule == o.input_rule &&
+          item_custom_fields == o.item_custom_fields &&
+          json == o.json &&
+          key == o.key &&
+          lock_on_read == o.lock_on_read &&
+          lock_ttl == o.lock_ttl &&
+          max_versions == o.max_versions &&
+          name == o.name &&
+          output_rule == o.output_rule &&
+          password_length == o.password_length &&
+          rotate_on_unlock == o.rotate_on_unlock &&
+          rotated_password == o.rotated_password &&
+          rotated_username == o.rotated_username &&
+          rotation_event_in == o.rotation_event_in &&
+          rotation_hour == o.rotation_hour &&
+          rotation_interval == o.rotation_interval &&
+          rotator_type == o.rotator_type &&
+          skip_dry_run == o.skip_dry_run &&
+          tags == o.tags &&
+          target_name == o.target_name &&
+          token == o.token &&
+          uid_token == o.uid_token &&
+          use_capital_letters == o.use_capital_letters &&
+          use_lower_letters == o.use_lower_letters &&
+          use_numbers == o.use_numbers &&
+          use_special_characters == o.use_special_characters
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [ara_enabled, authentication_credentials, auto_rotate, delete_protection, description, enable_agentic_runtime_authority, enable_ai_quorum, input_rule, item_custom_fields, json, key, lock_on_read, lock_ttl, max_versions, name, output_rule, password_length, rotate_on_unlock, rotated_password, rotated_username, rotation_event_in, rotation_hour, rotation_interval, rotator_type, skip_dry_run, tags, target_name, token, uid_token, use_capital_letters, use_lower_letters, use_numbers, use_special_characters].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Akeyless.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end