akeyless 5.0.19 → 5.0.21

data/lib/akeyless/models/rotated_secret_create_splunk.rb

@@ -0,0 +1,497 @@
+=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
+  # rotatedSecretCreateSplunk is a command that creates a rotated secret for a Splunk target. Currently we support target-rotator behavior (rotate credentials on the target itself).
+  class RotatedSecretCreateSplunk
+    # Token audience for Splunk token creation (required for rotator-type=token)
+    attr_accessor :audience
+
+    # The credentials to connect with use-user-creds/use-target-creds
+    attr_accessor :authentication_credentials
+
+    # Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]
+    attr_accessor :auto_rotate
+
+    # Protection from accidental deletion of this object [true/false]
+    attr_accessor :delete_protection
+
+    # Description of the object
+    attr_accessor :description
+
+    # Token expiration date in YYYY-MM-DD format (required for rotator-type=token when manual rotation is selected and no existing token is provided). Time will be set to 00:00 UTC.
+    attr_accessor :expiration_date
+
+    # Current Splunk HEC token value to store (relevant only for rotator-type=hec-token). If not provided, a new HEC input will be created in Splunk.
+    attr_accessor :hec_token
+
+    # Splunk HEC input name to manage  (required for rotator-type=hec-token)
+    attr_accessor :hec_token_name
+
+    # Additional custom fields to associate with the item
+    attr_accessor :item_custom_fields
+
+    # Set output format to JSON
+    attr_accessor :json
+
+    # The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
+    attr_accessor :key
+
+    # Set the maximum number of versions, limited by the account settings defaults.
+    attr_accessor :max_versions
+
+    # Rotated secret name
+    attr_accessor :name
+
+    # The length of the password to be generated
+    attr_accessor :password_length
+
+    # 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
+
+    # The Hour of the rotation in UTC
+    attr_accessor :rotation_hour
+
+    # The number of days to wait between every automatic key rotation (1-365)
+    attr_accessor :rotation_interval
+
+    # The rotator type. options: [target/password/token/hec-token]
+    attr_accessor :rotator_type
+
+    # Current Splunk authentication token to store (relevant only for rotator-type=token). If not provided, a new token will be created in Splunk.
+    attr_accessor :splunk_token
+
+    # Add tags attached to this object
+    attr_accessor :tags
+
+    # The target name to associate
+    attr_accessor :target_name
+
+    # Authentication token (see `/auth` and `/configure`)
+    attr_accessor :token
+
+    # Splunk token owner username (relevant only for rotator-type=token)
+    attr_accessor :token_owner
+
+    # The universal identity token, Required only for universal_identity authentication
+    attr_accessor :uid_token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'audience' => :'audience',
+        :'authentication_credentials' => :'authentication-credentials',
+        :'auto_rotate' => :'auto-rotate',
+        :'delete_protection' => :'delete_protection',
+        :'description' => :'description',
+        :'expiration_date' => :'expiration-date',
+        :'hec_token' => :'hec-token',
+        :'hec_token_name' => :'hec-token-name',
+        :'item_custom_fields' => :'item-custom-fields',
+        :'json' => :'json',
+        :'key' => :'key',
+        :'max_versions' => :'max-versions',
+        :'name' => :'name',
+        :'password_length' => :'password-length',
+        :'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',
+        :'splunk_token' => :'splunk-token',
+        :'tags' => :'tags',
+        :'target_name' => :'target-name',
+        :'token' => :'token',
+        :'token_owner' => :'token-owner',
+        :'uid_token' => :'uid-token'
+      }
+    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
+      {
+        :'audience' => :'String',
+        :'authentication_credentials' => :'String',
+        :'auto_rotate' => :'String',
+        :'delete_protection' => :'String',
+        :'description' => :'String',
+        :'expiration_date' => :'String',
+        :'hec_token' => :'String',
+        :'hec_token_name' => :'String',
+        :'item_custom_fields' => :'Hash<String, String>',
+        :'json' => :'Boolean',
+        :'key' => :'String',
+        :'max_versions' => :'String',
+        :'name' => :'String',
+        :'password_length' => :'String',
+        :'rotated_password' => :'String',
+        :'rotated_username' => :'String',
+        :'rotation_event_in' => :'Array<String>',
+        :'rotation_hour' => :'Integer',
+        :'rotation_interval' => :'String',
+        :'rotator_type' => :'String',
+        :'splunk_token' => :'String',
+        :'tags' => :'Array<String>',
+        :'target_name' => :'String',
+        :'token' => :'String',
+        :'token_owner' => :'String',
+        :'uid_token' => :'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::RotatedSecretCreateSplunk` 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::RotatedSecretCreateSplunk`. 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?(:'audience')
+        self.audience = attributes[:'audience']
+      end
+
+      if attributes.key?(:'authentication_credentials')
+        self.authentication_credentials = attributes[:'authentication_credentials']
+      else
+        self.authentication_credentials = 'use-user-creds'
+      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?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      end
+
+      if attributes.key?(:'hec_token')
+        self.hec_token = attributes[:'hec_token']
+      end
+
+      if attributes.key?(:'hec_token_name')
+        self.hec_token_name = attributes[:'hec_token_name']
+      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?(:'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?(:'password_length')
+        self.password_length = attributes[:'password_length']
+      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']
+      else
+        self.rotator_type = nil
+      end
+
+      if attributes.key?(:'splunk_token')
+        self.splunk_token = attributes[:'splunk_token']
+      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?(:'token_owner')
+        self.token_owner = attributes[:'token_owner']
+      end
+
+      if attributes.key?(:'uid_token')
+        self.uid_token = attributes[:'uid_token']
+      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 @rotator_type.nil?
+        invalid_properties.push('invalid value for "rotator_type", rotator_type 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 @rotator_type.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 &&
+          audience == o.audience &&
+          authentication_credentials == o.authentication_credentials &&
+          auto_rotate == o.auto_rotate &&
+          delete_protection == o.delete_protection &&
+          description == o.description &&
+          expiration_date == o.expiration_date &&
+          hec_token == o.hec_token &&
+          hec_token_name == o.hec_token_name &&
+          item_custom_fields == o.item_custom_fields &&
+          json == o.json &&
+          key == o.key &&
+          max_versions == o.max_versions &&
+          name == o.name &&
+          password_length == o.password_length &&
+          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 &&
+          splunk_token == o.splunk_token &&
+          tags == o.tags &&
+          target_name == o.target_name &&
+          token == o.token &&
+          token_owner == o.token_owner &&
+          uid_token == o.uid_token
+    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
+      [audience, authentication_credentials, auto_rotate, delete_protection, description, expiration_date, hec_token, hec_token_name, item_custom_fields, json, key, max_versions, name, password_length, rotated_password, rotated_username, rotation_event_in, rotation_hour, rotation_interval, rotator_type, splunk_token, tags, target_name, token, token_owner, uid_token].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

data/lib/akeyless/models/rotated_secret_create_ssh.rb

@@ -108,7 +108,7 @@ module Akeyless
     # Add tags attached to this object
     attr_accessor :tags
 
-    # Target name
+    # The target name to associate
     attr_accessor :target_name
 
     # Authentication token (see `/auth` and `/configure`)

data/lib/akeyless/models/rotated_secret_create_windows.rb

@@ -93,7 +93,7 @@ module Akeyless
     # Add tags attached to this object
     attr_accessor :tags
 
-    # Target name
+    # The target name to associate
     attr_accessor :target_name
 
     # Authentication token (see `/auth` and `/configure`)

data/lib/akeyless/models/rotated_secret_details_info.rb

@@ -26,6 +26,8 @@ module Akeyless
 
     attr_accessor :grace_rotation_interval
 
+    attr_accessor :grace_rotation_timing
+
     attr_accessor :gw_cluster_id
 
     attr_accessor :iis_apps_details
@@ -69,6 +71,7 @@ module Akeyless
         :'grace_rotation' => :'grace_rotation',
         :'grace_rotation_hour' => :'grace_rotation_hour',
         :'grace_rotation_interval' => :'grace_rotation_interval',
+        :'grace_rotation_timing' => :'grace_rotation_timing',
         :'gw_cluster_id' => :'gw_cluster_id',
         :'iis_apps_details' => :'iis_apps_details',
         :'last_rotation_error' => :'last_rotation_error',
@@ -102,6 +105,7 @@ module Akeyless
         :'grace_rotation' => :'Boolean',
         :'grace_rotation_hour' => :'Integer',
         :'grace_rotation_interval' => :'Integer',
+        :'grace_rotation_timing' => :'String',
         :'gw_cluster_id' => :'Integer',
         :'iis_apps_details' => :'Array<WindowsService>',
         :'last_rotation_error' => :'String',
@@ -163,6 +167,10 @@ module Akeyless
         self.grace_rotation_interval = attributes[:'grace_rotation_interval']
       end
 
+      if attributes.key?(:'grace_rotation_timing')
+        self.grace_rotation_timing = attributes[:'grace_rotation_timing']
+      end
+
       if attributes.key?(:'gw_cluster_id')
         self.gw_cluster_id = attributes[:'gw_cluster_id']
       end
@@ -261,6 +269,7 @@ module Akeyless
           grace_rotation == o.grace_rotation &&
           grace_rotation_hour == o.grace_rotation_hour &&
           grace_rotation_interval == o.grace_rotation_interval &&
+          grace_rotation_timing == o.grace_rotation_timing &&
           gw_cluster_id == o.gw_cluster_id &&
           iis_apps_details == o.iis_apps_details &&
           last_rotation_error == o.last_rotation_error &&
@@ -289,7 +298,7 @@ module Akeyless
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [delete_previous_version_in_days, enable_custom_password_policy, grace_rotation, grace_rotation_hour, grace_rotation_interval, gw_cluster_id, iis_apps_details, last_rotation_error, managed_by_akeyless, max_versions, next_auto_rotate_type, number_of_versions_to_save, public_key_remote_path, rotation_hour, rotation_interval_min, rotation_statement, rotator_creds_type, rotator_status, rotator_type, same_password, services_details, timeout_seconds].hash
+      [delete_previous_version_in_days, enable_custom_password_policy, grace_rotation, grace_rotation_hour, grace_rotation_interval, grace_rotation_timing, gw_cluster_id, iis_apps_details, last_rotation_error, managed_by_akeyless, max_versions, next_auto_rotate_type, number_of_versions_to_save, public_key_remote_path, rotation_hour, rotation_interval_min, rotation_statement, rotator_creds_type, rotator_status, rotator_type, same_password, services_details, timeout_seconds].hash
     end
 
     # Builds the object from hash

data/lib/akeyless/models/rotated_secret_update_aws.rb

@@ -39,7 +39,7 @@ module Akeyless
     # Description of the object
     attr_accessor :description
 
-    # Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
+    # Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false]
     attr_accessor :grace_rotation
 
     # The Hour of the grace rotation in UTC
@@ -48,6 +48,9 @@ module Akeyless
     # The number of days to wait before deleting the old key (must be bigger than rotation-interval)
     attr_accessor :grace_rotation_interval
 
+    # When to create the new version relative to the rotation date [after/before]
+    attr_accessor :grace_rotation_timing
+
     # Additional custom fields to associate with the item
     attr_accessor :item_custom_fields
 
@@ -122,6 +125,7 @@ module Akeyless
         :'grace_rotation' => :'grace-rotation',
         :'grace_rotation_hour' => :'grace-rotation-hour',
         :'grace_rotation_interval' => :'grace-rotation-interval',
+        :'grace_rotation_timing' => :'grace-rotation-timing',
         :'item_custom_fields' => :'item-custom-fields',
         :'json' => :'json',
         :'keep_prev_version' => :'keep-prev-version',
@@ -164,6 +168,7 @@ module Akeyless
         :'grace_rotation' => :'String',
         :'grace_rotation_hour' => :'Integer',
         :'grace_rotation_interval' => :'String',
+        :'grace_rotation_timing' => :'String',
         :'item_custom_fields' => :'Hash<String, String>',
         :'json' => :'Boolean',
         :'keep_prev_version' => :'String',
@@ -260,6 +265,10 @@ module Akeyless
         self.grace_rotation_interval = attributes[:'grace_rotation_interval']
       end
 
+      if attributes.key?(:'grace_rotation_timing')
+        self.grace_rotation_timing = attributes[:'grace_rotation_timing']
+      end
+
       if attributes.key?(:'item_custom_fields')
         if (value = attributes[:'item_custom_fields']).is_a?(Hash)
           self.item_custom_fields = value
@@ -389,6 +398,7 @@ module Akeyless
           grace_rotation == o.grace_rotation &&
           grace_rotation_hour == o.grace_rotation_hour &&
           grace_rotation_interval == o.grace_rotation_interval &&
+          grace_rotation_timing == o.grace_rotation_timing &&
           item_custom_fields == o.item_custom_fields &&
           json == o.json &&
           keep_prev_version == o.keep_prev_version &&
@@ -420,7 +430,7 @@ module Akeyless
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [add_tag, api_id, api_key, authentication_credentials, auto_rotate, aws_region, delete_protection, description, grace_rotation, grace_rotation_hour, grace_rotation_interval, item_custom_fields, json, keep_prev_version, key, max_versions, name, new_name, password_length, rm_tag, rotate_after_disconnect, rotation_event_in, rotation_hour, rotation_interval, secure_access_aws_account_id, secure_access_aws_native_cli, secure_access_bastion_issuer, secure_access_certificate_issuer, secure_access_enable, token, uid_token].hash
+      [add_tag, api_id, api_key, authentication_credentials, auto_rotate, aws_region, delete_protection, description, grace_rotation, grace_rotation_hour, grace_rotation_interval, grace_rotation_timing, item_custom_fields, json, keep_prev_version, key, max_versions, name, new_name, password_length, rm_tag, rotate_after_disconnect, rotation_event_in, rotation_hour, rotation_interval, secure_access_aws_account_id, secure_access_aws_native_cli, secure_access_bastion_issuer, secure_access_certificate_issuer, secure_access_enable, token, uid_token].hash
     end
 
     # Builds the object from hash