zitadel-client 1.3.2

data/lib/zitadel-client/models/settings_service_login_settings.rb

@@ -0,0 +1,437 @@
+=begin
+#Zitadel SDK
+
+#The Zitadel SDK is a convenience wrapper around the Zitadel APIs to assist you in integrating with your Zitadel environment. This SDK enables you to handle resources, settings, and configurations within the Zitadel platform.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ZitadelClient
+  class SettingsServiceLoginSettings
+    # defines if a user is allowed to log in with username and password
+    attr_accessor :allow_username_password
+
+    # defines if a person is allowed to register a user on this organization
+    attr_accessor :allow_register
+
+    # defines if a user is allowed to add a defined identity provider. E.g. Google auth
+    attr_accessor :allow_external_idp
+
+    # defines if a user MUST use a multi-factor to log in
+    attr_accessor :force_mfa
+
+    attr_accessor :passkeys_type
+
+    # defines if password reset link should be shown in the login screen
+    attr_accessor :hide_password_reset
+
+    # defines if unknown username on login screen directly returns an error or always displays the password screen
+    attr_accessor :ignore_unknown_usernames
+
+    # defines where the user will be redirected to if the login is started without app context (e.g. from mail)
+    attr_accessor :default_redirect_uri
+
+    # Defines after how much time the user has to re-authenticate with the password.
+    attr_accessor :password_check_lifetime
+
+    # Defines after how much time the user has to re-authenticate with an external provider.
+    attr_accessor :external_login_check_lifetime
+
+    # Defines after how much time the mfa prompt will be shown again.
+    attr_accessor :mfa_init_skip_lifetime
+
+    # Defines after how long the second factor check is valid.
+    attr_accessor :second_factor_check_lifetime
+
+    # Defines how long the multi-factor check is valid.
+    attr_accessor :multi_factor_check_lifetime
+
+    attr_accessor :second_factors
+
+    attr_accessor :multi_factors
+
+    # If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success.
+    attr_accessor :allow_domain_discovery
+
+    # defines if the user can additionally (to the login name) be identified by their verified email address
+    attr_accessor :disable_login_with_email
+
+    # defines if the user can additionally (to the login name) be identified by their verified phone number
+    attr_accessor :disable_login_with_phone
+
+    attr_accessor :resource_owner_type
+
+    # if activated, only local authenticated users are forced to use MFA. Authentication through IDPs won't prompt a MFA step in the login.
+    attr_accessor :force_mfa_local_only
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'allow_username_password' => :'allowUsernamePassword',
+        :'allow_register' => :'allowRegister',
+        :'allow_external_idp' => :'allowExternalIdp',
+        :'force_mfa' => :'forceMfa',
+        :'passkeys_type' => :'passkeysType',
+        :'hide_password_reset' => :'hidePasswordReset',
+        :'ignore_unknown_usernames' => :'ignoreUnknownUsernames',
+        :'default_redirect_uri' => :'defaultRedirectUri',
+        :'password_check_lifetime' => :'passwordCheckLifetime',
+        :'external_login_check_lifetime' => :'externalLoginCheckLifetime',
+        :'mfa_init_skip_lifetime' => :'mfaInitSkipLifetime',
+        :'second_factor_check_lifetime' => :'secondFactorCheckLifetime',
+        :'multi_factor_check_lifetime' => :'multiFactorCheckLifetime',
+        :'second_factors' => :'secondFactors',
+        :'multi_factors' => :'multiFactors',
+        :'allow_domain_discovery' => :'allowDomainDiscovery',
+        :'disable_login_with_email' => :'disableLoginWithEmail',
+        :'disable_login_with_phone' => :'disableLoginWithPhone',
+        :'resource_owner_type' => :'resourceOwnerType',
+        :'force_mfa_local_only' => :'forceMfaLocalOnly'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'allow_username_password' => :'Boolean',
+        :'allow_register' => :'Boolean',
+        :'allow_external_idp' => :'Boolean',
+        :'force_mfa' => :'Boolean',
+        :'passkeys_type' => :'SettingsServicePasskeysType',
+        :'hide_password_reset' => :'Boolean',
+        :'ignore_unknown_usernames' => :'Boolean',
+        :'default_redirect_uri' => :'String',
+        :'password_check_lifetime' => :'String',
+        :'external_login_check_lifetime' => :'String',
+        :'mfa_init_skip_lifetime' => :'String',
+        :'second_factor_check_lifetime' => :'String',
+        :'multi_factor_check_lifetime' => :'String',
+        :'second_factors' => :'Array<SettingsServiceSecondFactorType>',
+        :'multi_factors' => :'Array<SettingsServiceMultiFactorType>',
+        :'allow_domain_discovery' => :'Boolean',
+        :'disable_login_with_email' => :'Boolean',
+        :'disable_login_with_phone' => :'Boolean',
+        :'resource_owner_type' => :'SettingsServiceResourceOwnerType',
+        :'force_mfa_local_only' => :'Boolean'
+      }
+    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 `ZitadelClient::SettingsServiceLoginSettings` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ZitadelClient::SettingsServiceLoginSettings`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'allow_username_password')
+        self.allow_username_password = attributes[:'allow_username_password']
+      end
+
+      if attributes.key?(:'allow_register')
+        self.allow_register = attributes[:'allow_register']
+      end
+
+      if attributes.key?(:'allow_external_idp')
+        self.allow_external_idp = attributes[:'allow_external_idp']
+      end
+
+      if attributes.key?(:'force_mfa')
+        self.force_mfa = attributes[:'force_mfa']
+      end
+
+      if attributes.key?(:'passkeys_type')
+        self.passkeys_type = attributes[:'passkeys_type']
+      else
+        self.passkeys_type = 'PASSKEYS_TYPE_NOT_ALLOWED'
+      end
+
+      if attributes.key?(:'hide_password_reset')
+        self.hide_password_reset = attributes[:'hide_password_reset']
+      end
+
+      if attributes.key?(:'ignore_unknown_usernames')
+        self.ignore_unknown_usernames = attributes[:'ignore_unknown_usernames']
+      end
+
+      if attributes.key?(:'default_redirect_uri')
+        self.default_redirect_uri = attributes[:'default_redirect_uri']
+      end
+
+      if attributes.key?(:'password_check_lifetime')
+        self.password_check_lifetime = attributes[:'password_check_lifetime']
+      end
+
+      if attributes.key?(:'external_login_check_lifetime')
+        self.external_login_check_lifetime = attributes[:'external_login_check_lifetime']
+      end
+
+      if attributes.key?(:'mfa_init_skip_lifetime')
+        self.mfa_init_skip_lifetime = attributes[:'mfa_init_skip_lifetime']
+      end
+
+      if attributes.key?(:'second_factor_check_lifetime')
+        self.second_factor_check_lifetime = attributes[:'second_factor_check_lifetime']
+      end
+
+      if attributes.key?(:'multi_factor_check_lifetime')
+        self.multi_factor_check_lifetime = attributes[:'multi_factor_check_lifetime']
+      end
+
+      if attributes.key?(:'second_factors')
+        if (value = attributes[:'second_factors']).is_a?(Array)
+          self.second_factors = value
+        end
+      end
+
+      if attributes.key?(:'multi_factors')
+        if (value = attributes[:'multi_factors']).is_a?(Array)
+          self.multi_factors = value
+        end
+      end
+
+      if attributes.key?(:'allow_domain_discovery')
+        self.allow_domain_discovery = attributes[:'allow_domain_discovery']
+      end
+
+      if attributes.key?(:'disable_login_with_email')
+        self.disable_login_with_email = attributes[:'disable_login_with_email']
+      end
+
+      if attributes.key?(:'disable_login_with_phone')
+        self.disable_login_with_phone = attributes[:'disable_login_with_phone']
+      end
+
+      if attributes.key?(:'resource_owner_type')
+        self.resource_owner_type = attributes[:'resource_owner_type']
+      else
+        self.resource_owner_type = 'RESOURCE_OWNER_TYPE_UNSPECIFIED'
+      end
+
+      if attributes.key?(:'force_mfa_local_only')
+        self.force_mfa_local_only = attributes[:'force_mfa_local_only']
+      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
+      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'
+      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 &&
+          allow_username_password == o.allow_username_password &&
+          allow_register == o.allow_register &&
+          allow_external_idp == o.allow_external_idp &&
+          force_mfa == o.force_mfa &&
+          passkeys_type == o.passkeys_type &&
+          hide_password_reset == o.hide_password_reset &&
+          ignore_unknown_usernames == o.ignore_unknown_usernames &&
+          default_redirect_uri == o.default_redirect_uri &&
+          password_check_lifetime == o.password_check_lifetime &&
+          external_login_check_lifetime == o.external_login_check_lifetime &&
+          mfa_init_skip_lifetime == o.mfa_init_skip_lifetime &&
+          second_factor_check_lifetime == o.second_factor_check_lifetime &&
+          multi_factor_check_lifetime == o.multi_factor_check_lifetime &&
+          second_factors == o.second_factors &&
+          multi_factors == o.multi_factors &&
+          allow_domain_discovery == o.allow_domain_discovery &&
+          disable_login_with_email == o.disable_login_with_email &&
+          disable_login_with_phone == o.disable_login_with_phone &&
+          resource_owner_type == o.resource_owner_type &&
+          force_mfa_local_only == o.force_mfa_local_only
+    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
+      [allow_username_password, allow_register, allow_external_idp, force_mfa, passkeys_type, hide_password_reset, ignore_unknown_usernames, default_redirect_uri, password_check_lifetime, external_login_check_lifetime, mfa_init_skip_lifetime, second_factor_check_lifetime, multi_factor_check_lifetime, second_factors, multi_factors, allow_domain_discovery, disable_login_with_email, disable_login_with_phone, resource_owner_type, force_mfa_local_only].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 = ZitadelClient.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/zitadel-client/models/settings_service_multi_factor_type.rb

@@ -0,0 +1,40 @@
+=begin
+#Zitadel SDK
+
+#The Zitadel SDK is a convenience wrapper around the Zitadel APIs to assist you in integrating with your Zitadel environment. This SDK enables you to handle resources, settings, and configurations within the Zitadel platform.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ZitadelClient
+  class SettingsServiceMultiFactorType
+    MULTI_FACTOR_TYPE_UNSPECIFIED = "MULTI_FACTOR_TYPE_UNSPECIFIED".freeze
+    MULTI_FACTOR_TYPE_U2_F_WITH_VERIFICATION = "MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION".freeze
+
+    def self.all_vars
+      @all_vars ||= [MULTI_FACTOR_TYPE_UNSPECIFIED, MULTI_FACTOR_TYPE_U2_F_WITH_VERIFICATION].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if SettingsServiceMultiFactorType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #SettingsServiceMultiFactorType"
+    end
+  end
+end