authentik-api 2025.12.4

data/lib/authentik/api/models/saml_source_request.rb

@@ -0,0 +1,578 @@
+=begin
+This file is automatically generated by: https://openapi-generator.tech.
+Any manual changes will be lost when the OpenAPI scheme changes.
+
+=end
+
+require 'date'
+require 'time'
+
+module Authentik::Api
+  # SAMLSource Serializer
+  class SAMLSourceRequest < ApiModelBase
+    # Source's display Name.
+    attr_accessor :name
+
+    # Internal source name, used in URLs.
+    attr_accessor :slug
+
+    attr_accessor :enabled
+
+    # When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
+    attr_accessor :promoted
+
+    # Flow to use when authenticating existing users.
+    attr_accessor :authentication_flow
+
+    # Flow to use when enrolling new users.
+    attr_accessor :enrollment_flow
+
+    attr_accessor :user_property_mappings
+
+    attr_accessor :group_property_mappings
+
+    attr_accessor :policy_engine_mode
+
+    # How the source determines if an existing user should be authenticated or a new user enrolled.
+    attr_accessor :user_matching_mode
+
+    attr_accessor :user_path_template
+
+    attr_accessor :icon
+
+    # How the source determines if an existing group should be used or a new group created.
+    attr_accessor :group_matching_mode
+
+    # Flow used before authentication.
+    attr_accessor :pre_authentication_flow
+
+    # Also known as Entity ID. Defaults the Metadata URL.
+    attr_accessor :issuer
+
+    # URL that the initial Login request is sent to.
+    attr_accessor :sso_url
+
+    # Optional URL if your IDP supports Single-Logout.
+    attr_accessor :slo_url
+
+    # Allows authentication flows initiated by the IdP. This can be a security risk, as no validation of the request ID is done.
+    attr_accessor :allow_idp_initiated
+
+    # NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
+    attr_accessor :name_id_policy
+
+    attr_accessor :binding_type
+
+    # When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default.
+    attr_accessor :verification_kp
+
+    # Keypair used to sign outgoing Responses going to the Identity Provider.
+    attr_accessor :signing_kp
+
+    attr_accessor :digest_algorithm
+
+    attr_accessor :signature_algorithm
+
+    # Time offset when temporary users should be deleted. This only applies if your IDP uses the NameID Format 'transient', and the user doesn't log out manually. (Format: hours=1;minutes=2;seconds=3).
+    attr_accessor :temporary_user_delete_after
+
+    # When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the the private key.
+    attr_accessor :encryption_kp
+
+    attr_accessor :signed_assertion
+
+    attr_accessor :signed_response
+
+    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
+      {
+        :'name' => :'name',
+        :'slug' => :'slug',
+        :'enabled' => :'enabled',
+        :'promoted' => :'promoted',
+        :'authentication_flow' => :'authentication_flow',
+        :'enrollment_flow' => :'enrollment_flow',
+        :'user_property_mappings' => :'user_property_mappings',
+        :'group_property_mappings' => :'group_property_mappings',
+        :'policy_engine_mode' => :'policy_engine_mode',
+        :'user_matching_mode' => :'user_matching_mode',
+        :'user_path_template' => :'user_path_template',
+        :'icon' => :'icon',
+        :'group_matching_mode' => :'group_matching_mode',
+        :'pre_authentication_flow' => :'pre_authentication_flow',
+        :'issuer' => :'issuer',
+        :'sso_url' => :'sso_url',
+        :'slo_url' => :'slo_url',
+        :'allow_idp_initiated' => :'allow_idp_initiated',
+        :'name_id_policy' => :'name_id_policy',
+        :'binding_type' => :'binding_type',
+        :'verification_kp' => :'verification_kp',
+        :'signing_kp' => :'signing_kp',
+        :'digest_algorithm' => :'digest_algorithm',
+        :'signature_algorithm' => :'signature_algorithm',
+        :'temporary_user_delete_after' => :'temporary_user_delete_after',
+        :'encryption_kp' => :'encryption_kp',
+        :'signed_assertion' => :'signed_assertion',
+        :'signed_response' => :'signed_response'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'slug' => :'String',
+        :'enabled' => :'Boolean',
+        :'promoted' => :'Boolean',
+        :'authentication_flow' => :'String',
+        :'enrollment_flow' => :'String',
+        :'user_property_mappings' => :'Array<String>',
+        :'group_property_mappings' => :'Array<String>',
+        :'policy_engine_mode' => :'PolicyEngineMode',
+        :'user_matching_mode' => :'UserMatchingModeEnum',
+        :'user_path_template' => :'String',
+        :'icon' => :'String',
+        :'group_matching_mode' => :'GroupMatchingModeEnum',
+        :'pre_authentication_flow' => :'String',
+        :'issuer' => :'String',
+        :'sso_url' => :'String',
+        :'slo_url' => :'String',
+        :'allow_idp_initiated' => :'Boolean',
+        :'name_id_policy' => :'SAMLNameIDPolicyEnum',
+        :'binding_type' => :'BindingTypeEnum',
+        :'verification_kp' => :'String',
+        :'signing_kp' => :'String',
+        :'digest_algorithm' => :'DigestAlgorithmEnum',
+        :'signature_algorithm' => :'SignatureAlgorithmEnum',
+        :'temporary_user_delete_after' => :'String',
+        :'encryption_kp' => :'String',
+        :'signed_assertion' => :'Boolean',
+        :'signed_response' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'authentication_flow',
+        :'enrollment_flow',
+        :'slo_url',
+        :'verification_kp',
+        :'signing_kp',
+        :'encryption_kp',
+      ])
+    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 `Authentik::Api::SAMLSourceRequest` 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 `Authentik::Api::SAMLSourceRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      else
+        self.slug = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'promoted')
+        self.promoted = attributes[:'promoted']
+      end
+
+      if attributes.key?(:'authentication_flow')
+        self.authentication_flow = attributes[:'authentication_flow']
+      end
+
+      if attributes.key?(:'enrollment_flow')
+        self.enrollment_flow = attributes[:'enrollment_flow']
+      end
+
+      if attributes.key?(:'user_property_mappings')
+        if (value = attributes[:'user_property_mappings']).is_a?(Array)
+          self.user_property_mappings = value
+        end
+      end
+
+      if attributes.key?(:'group_property_mappings')
+        if (value = attributes[:'group_property_mappings']).is_a?(Array)
+          self.group_property_mappings = value
+        end
+      end
+
+      if attributes.key?(:'policy_engine_mode')
+        self.policy_engine_mode = attributes[:'policy_engine_mode']
+      end
+
+      if attributes.key?(:'user_matching_mode')
+        self.user_matching_mode = attributes[:'user_matching_mode']
+      end
+
+      if attributes.key?(:'user_path_template')
+        self.user_path_template = attributes[:'user_path_template']
+      end
+
+      if attributes.key?(:'icon')
+        self.icon = attributes[:'icon']
+      end
+
+      if attributes.key?(:'group_matching_mode')
+        self.group_matching_mode = attributes[:'group_matching_mode']
+      end
+
+      if attributes.key?(:'pre_authentication_flow')
+        self.pre_authentication_flow = attributes[:'pre_authentication_flow']
+      else
+        self.pre_authentication_flow = nil
+      end
+
+      if attributes.key?(:'issuer')
+        self.issuer = attributes[:'issuer']
+      end
+
+      if attributes.key?(:'sso_url')
+        self.sso_url = attributes[:'sso_url']
+      else
+        self.sso_url = nil
+      end
+
+      if attributes.key?(:'slo_url')
+        self.slo_url = attributes[:'slo_url']
+      end
+
+      if attributes.key?(:'allow_idp_initiated')
+        self.allow_idp_initiated = attributes[:'allow_idp_initiated']
+      end
+
+      if attributes.key?(:'name_id_policy')
+        self.name_id_policy = attributes[:'name_id_policy']
+      end
+
+      if attributes.key?(:'binding_type')
+        self.binding_type = attributes[:'binding_type']
+      end
+
+      if attributes.key?(:'verification_kp')
+        self.verification_kp = attributes[:'verification_kp']
+      end
+
+      if attributes.key?(:'signing_kp')
+        self.signing_kp = attributes[:'signing_kp']
+      end
+
+      if attributes.key?(:'digest_algorithm')
+        self.digest_algorithm = attributes[:'digest_algorithm']
+      end
+
+      if attributes.key?(:'signature_algorithm')
+        self.signature_algorithm = attributes[:'signature_algorithm']
+      end
+
+      if attributes.key?(:'temporary_user_delete_after')
+        self.temporary_user_delete_after = attributes[:'temporary_user_delete_after']
+      end
+
+      if attributes.key?(:'encryption_kp')
+        self.encryption_kp = attributes[:'encryption_kp']
+      end
+
+      if attributes.key?(:'signed_assertion')
+        self.signed_assertion = attributes[:'signed_assertion']
+      end
+
+      if attributes.key?(:'signed_response')
+        self.signed_response = attributes[:'signed_response']
+      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 @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      end
+
+      if @slug.nil?
+        invalid_properties.push('invalid value for "slug", slug cannot be nil.')
+      end
+
+      if @slug.to_s.length < 1
+        invalid_properties.push('invalid value for "slug", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[-a-zA-Z0-9_]+$/)
+      if @slug !~ pattern
+        invalid_properties.push("invalid value for \"slug\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@user_path_template.nil? && @user_path_template.to_s.length < 1
+        invalid_properties.push('invalid value for "user_path_template", the character length must be greater than or equal to 1.')
+      end
+
+      if @pre_authentication_flow.nil?
+        invalid_properties.push('invalid value for "pre_authentication_flow", pre_authentication_flow cannot be nil.')
+      end
+
+      if @sso_url.nil?
+        invalid_properties.push('invalid value for "sso_url", sso_url cannot be nil.')
+      end
+
+      if @sso_url.to_s.length < 1
+        invalid_properties.push('invalid value for "sso_url", the character length must be greater than or equal to 1.')
+      end
+
+      if !@temporary_user_delete_after.nil? && @temporary_user_delete_after.to_s.length < 1
+        invalid_properties.push('invalid value for "temporary_user_delete_after", the character length must be greater than or equal to 1.')
+      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 @name.to_s.length < 1
+      return false if @slug.nil?
+      return false if @slug.to_s.length < 1
+      return false if @slug !~ Regexp.new(/^[-a-zA-Z0-9_]+$/)
+      return false if !@user_path_template.nil? && @user_path_template.to_s.length < 1
+      return false if @pre_authentication_flow.nil?
+      return false if @sso_url.nil?
+      return false if @sso_url.to_s.length < 1
+      return false if !@temporary_user_delete_after.nil? && @temporary_user_delete_after.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] slug Value to be assigned
+    def slug=(slug)
+      if slug.nil?
+        fail ArgumentError, 'slug cannot be nil'
+      end
+
+      if slug.to_s.length < 1
+        fail ArgumentError, 'invalid value for "slug", the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[-a-zA-Z0-9_]+$/)
+      if slug !~ pattern
+        fail ArgumentError, "invalid value for \"slug\", must conform to the pattern #{pattern}."
+      end
+
+      @slug = slug
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] user_path_template Value to be assigned
+    def user_path_template=(user_path_template)
+      if user_path_template.nil?
+        fail ArgumentError, 'user_path_template cannot be nil'
+      end
+
+      if user_path_template.to_s.length < 1
+        fail ArgumentError, 'invalid value for "user_path_template", the character length must be greater than or equal to 1.'
+      end
+
+      @user_path_template = user_path_template
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pre_authentication_flow Value to be assigned
+    def pre_authentication_flow=(pre_authentication_flow)
+      if pre_authentication_flow.nil?
+        fail ArgumentError, 'pre_authentication_flow cannot be nil'
+      end
+
+      @pre_authentication_flow = pre_authentication_flow
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sso_url Value to be assigned
+    def sso_url=(sso_url)
+      if sso_url.nil?
+        fail ArgumentError, 'sso_url cannot be nil'
+      end
+
+      if sso_url.to_s.length < 1
+        fail ArgumentError, 'invalid value for "sso_url", the character length must be greater than or equal to 1.'
+      end
+
+      @sso_url = sso_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] temporary_user_delete_after Value to be assigned
+    def temporary_user_delete_after=(temporary_user_delete_after)
+      if temporary_user_delete_after.nil?
+        fail ArgumentError, 'temporary_user_delete_after cannot be nil'
+      end
+
+      if temporary_user_delete_after.to_s.length < 1
+        fail ArgumentError, 'invalid value for "temporary_user_delete_after", the character length must be greater than or equal to 1.'
+      end
+
+      @temporary_user_delete_after = temporary_user_delete_after
+    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 &&
+          name == o.name &&
+          slug == o.slug &&
+          enabled == o.enabled &&
+          promoted == o.promoted &&
+          authentication_flow == o.authentication_flow &&
+          enrollment_flow == o.enrollment_flow &&
+          user_property_mappings == o.user_property_mappings &&
+          group_property_mappings == o.group_property_mappings &&
+          policy_engine_mode == o.policy_engine_mode &&
+          user_matching_mode == o.user_matching_mode &&
+          user_path_template == o.user_path_template &&
+          icon == o.icon &&
+          group_matching_mode == o.group_matching_mode &&
+          pre_authentication_flow == o.pre_authentication_flow &&
+          issuer == o.issuer &&
+          sso_url == o.sso_url &&
+          slo_url == o.slo_url &&
+          allow_idp_initiated == o.allow_idp_initiated &&
+          name_id_policy == o.name_id_policy &&
+          binding_type == o.binding_type &&
+          verification_kp == o.verification_kp &&
+          signing_kp == o.signing_kp &&
+          digest_algorithm == o.digest_algorithm &&
+          signature_algorithm == o.signature_algorithm &&
+          temporary_user_delete_after == o.temporary_user_delete_after &&
+          encryption_kp == o.encryption_kp &&
+          signed_assertion == o.signed_assertion &&
+          signed_response == o.signed_response
+    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
+      [name, slug, enabled, promoted, authentication_flow, enrollment_flow, user_property_mappings, group_property_mappings, policy_engine_mode, user_matching_mode, user_path_template, icon, group_matching_mode, pre_authentication_flow, issuer, sso_url, slo_url, allow_idp_initiated, name_id_policy, binding_type, verification_kp, signing_kp, digest_algorithm, signature_algorithm, temporary_user_delete_after, encryption_kp, signed_assertion, signed_response].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
+
+    # 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
+
+  end
+
+end