authentik-api 2025.12.4 → 2026.2.1.1

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

@@ -0,0 +1,668 @@
+=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
+  # WSFederationProvider Serializer
+  class WSFederationProvider < ApiModelBase
+    attr_accessor :pk
+
+    attr_accessor :name
+
+    # Flow used for authentication when the associated application is accessed by an un-authenticated user.
+    attr_accessor :authentication_flow
+
+    # Flow used when authorizing this provider.
+    attr_accessor :authorization_flow
+
+    # Flow used ending the session from a provider.
+    attr_accessor :invalidation_flow
+
+    attr_accessor :property_mappings
+
+    # Get object component so that we know how to edit the object
+    attr_accessor :component
+
+    # Internal application name, used in URLs.
+    attr_accessor :assigned_application_slug
+
+    # Application's display Name.
+    attr_accessor :assigned_application_name
+
+    # Internal application name, used in URLs.
+    attr_accessor :assigned_backchannel_application_slug
+
+    # Application's display Name.
+    attr_accessor :assigned_backchannel_application_name
+
+    # Return object's verbose_name
+    attr_accessor :verbose_name
+
+    # Return object's plural verbose_name
+    attr_accessor :verbose_name_plural
+
+    # Return internal model name
+    attr_accessor :meta_model_name
+
+    attr_accessor :reply_url
+
+    attr_accessor :wtrealm
+
+    # Assertion valid not before current time + this value (Format: hours=-1;minutes=-2;seconds=-3).
+    attr_accessor :assertion_valid_not_before
+
+    # Assertion not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
+    attr_accessor :assertion_valid_not_on_or_after
+
+    # Session not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
+    attr_accessor :session_valid_not_on_or_after
+
+    # Configure how the NameID value will be created. When left empty, the NameIDPolicy of the incoming request will be considered
+    attr_accessor :name_id_mapping
+
+    # Configure how the AuthnContextClassRef value will be created. When left empty, the AuthnContextClassRef will be set based on which authentication methods the user used to authenticate.
+    attr_accessor :authn_context_class_ref_mapping
+
+    attr_accessor :digest_algorithm
+
+    attr_accessor :signature_algorithm
+
+    # Keypair used to sign outgoing Responses going to the Service Provider.
+    attr_accessor :signing_kp
+
+    # 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 :sign_assertion
+
+    attr_accessor :sign_logout_request
+
+    attr_accessor :default_name_id_policy
+
+    # Get metadata download URL
+    attr_accessor :url_download_metadata
+
+    # Get WS-Fed url
+    attr_accessor :url_wsfed
+
+    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
+      {
+        :'pk' => :'pk',
+        :'name' => :'name',
+        :'authentication_flow' => :'authentication_flow',
+        :'authorization_flow' => :'authorization_flow',
+        :'invalidation_flow' => :'invalidation_flow',
+        :'property_mappings' => :'property_mappings',
+        :'component' => :'component',
+        :'assigned_application_slug' => :'assigned_application_slug',
+        :'assigned_application_name' => :'assigned_application_name',
+        :'assigned_backchannel_application_slug' => :'assigned_backchannel_application_slug',
+        :'assigned_backchannel_application_name' => :'assigned_backchannel_application_name',
+        :'verbose_name' => :'verbose_name',
+        :'verbose_name_plural' => :'verbose_name_plural',
+        :'meta_model_name' => :'meta_model_name',
+        :'reply_url' => :'reply_url',
+        :'wtrealm' => :'wtrealm',
+        :'assertion_valid_not_before' => :'assertion_valid_not_before',
+        :'assertion_valid_not_on_or_after' => :'assertion_valid_not_on_or_after',
+        :'session_valid_not_on_or_after' => :'session_valid_not_on_or_after',
+        :'name_id_mapping' => :'name_id_mapping',
+        :'authn_context_class_ref_mapping' => :'authn_context_class_ref_mapping',
+        :'digest_algorithm' => :'digest_algorithm',
+        :'signature_algorithm' => :'signature_algorithm',
+        :'signing_kp' => :'signing_kp',
+        :'encryption_kp' => :'encryption_kp',
+        :'sign_assertion' => :'sign_assertion',
+        :'sign_logout_request' => :'sign_logout_request',
+        :'default_name_id_policy' => :'default_name_id_policy',
+        :'url_download_metadata' => :'url_download_metadata',
+        :'url_wsfed' => :'url_wsfed'
+      }
+    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
+      {
+        :'pk' => :'Integer',
+        :'name' => :'String',
+        :'authentication_flow' => :'String',
+        :'authorization_flow' => :'String',
+        :'invalidation_flow' => :'String',
+        :'property_mappings' => :'Array<String>',
+        :'component' => :'String',
+        :'assigned_application_slug' => :'String',
+        :'assigned_application_name' => :'String',
+        :'assigned_backchannel_application_slug' => :'String',
+        :'assigned_backchannel_application_name' => :'String',
+        :'verbose_name' => :'String',
+        :'verbose_name_plural' => :'String',
+        :'meta_model_name' => :'String',
+        :'reply_url' => :'String',
+        :'wtrealm' => :'String',
+        :'assertion_valid_not_before' => :'String',
+        :'assertion_valid_not_on_or_after' => :'String',
+        :'session_valid_not_on_or_after' => :'String',
+        :'name_id_mapping' => :'String',
+        :'authn_context_class_ref_mapping' => :'String',
+        :'digest_algorithm' => :'DigestAlgorithmEnum',
+        :'signature_algorithm' => :'SignatureAlgorithmEnum',
+        :'signing_kp' => :'String',
+        :'encryption_kp' => :'String',
+        :'sign_assertion' => :'Boolean',
+        :'sign_logout_request' => :'Boolean',
+        :'default_name_id_policy' => :'SAMLNameIDPolicyEnum',
+        :'url_download_metadata' => :'String',
+        :'url_wsfed' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'authentication_flow',
+        :'assigned_application_slug',
+        :'assigned_application_name',
+        :'assigned_backchannel_application_slug',
+        :'assigned_backchannel_application_name',
+        :'name_id_mapping',
+        :'authn_context_class_ref_mapping',
+        :'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::WSFederationProvider` 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::WSFederationProvider`. 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?(:'pk')
+        self.pk = attributes[:'pk']
+      else
+        self.pk = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'authentication_flow')
+        self.authentication_flow = attributes[:'authentication_flow']
+      end
+
+      if attributes.key?(:'authorization_flow')
+        self.authorization_flow = attributes[:'authorization_flow']
+      else
+        self.authorization_flow = nil
+      end
+
+      if attributes.key?(:'invalidation_flow')
+        self.invalidation_flow = attributes[:'invalidation_flow']
+      else
+        self.invalidation_flow = nil
+      end
+
+      if attributes.key?(:'property_mappings')
+        if (value = attributes[:'property_mappings']).is_a?(Array)
+          self.property_mappings = value
+        end
+      end
+
+      if attributes.key?(:'component')
+        self.component = attributes[:'component']
+      else
+        self.component = nil
+      end
+
+      if attributes.key?(:'assigned_application_slug')
+        self.assigned_application_slug = attributes[:'assigned_application_slug']
+      else
+        self.assigned_application_slug = nil
+      end
+
+      if attributes.key?(:'assigned_application_name')
+        self.assigned_application_name = attributes[:'assigned_application_name']
+      else
+        self.assigned_application_name = nil
+      end
+
+      if attributes.key?(:'assigned_backchannel_application_slug')
+        self.assigned_backchannel_application_slug = attributes[:'assigned_backchannel_application_slug']
+      else
+        self.assigned_backchannel_application_slug = nil
+      end
+
+      if attributes.key?(:'assigned_backchannel_application_name')
+        self.assigned_backchannel_application_name = attributes[:'assigned_backchannel_application_name']
+      else
+        self.assigned_backchannel_application_name = nil
+      end
+
+      if attributes.key?(:'verbose_name')
+        self.verbose_name = attributes[:'verbose_name']
+      else
+        self.verbose_name = nil
+      end
+
+      if attributes.key?(:'verbose_name_plural')
+        self.verbose_name_plural = attributes[:'verbose_name_plural']
+      else
+        self.verbose_name_plural = nil
+      end
+
+      if attributes.key?(:'meta_model_name')
+        self.meta_model_name = attributes[:'meta_model_name']
+      else
+        self.meta_model_name = nil
+      end
+
+      if attributes.key?(:'reply_url')
+        self.reply_url = attributes[:'reply_url']
+      else
+        self.reply_url = nil
+      end
+
+      if attributes.key?(:'wtrealm')
+        self.wtrealm = attributes[:'wtrealm']
+      else
+        self.wtrealm = nil
+      end
+
+      if attributes.key?(:'assertion_valid_not_before')
+        self.assertion_valid_not_before = attributes[:'assertion_valid_not_before']
+      end
+
+      if attributes.key?(:'assertion_valid_not_on_or_after')
+        self.assertion_valid_not_on_or_after = attributes[:'assertion_valid_not_on_or_after']
+      end
+
+      if attributes.key?(:'session_valid_not_on_or_after')
+        self.session_valid_not_on_or_after = attributes[:'session_valid_not_on_or_after']
+      end
+
+      if attributes.key?(:'name_id_mapping')
+        self.name_id_mapping = attributes[:'name_id_mapping']
+      end
+
+      if attributes.key?(:'authn_context_class_ref_mapping')
+        self.authn_context_class_ref_mapping = attributes[:'authn_context_class_ref_mapping']
+      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?(:'signing_kp')
+        self.signing_kp = attributes[:'signing_kp']
+      end
+
+      if attributes.key?(:'encryption_kp')
+        self.encryption_kp = attributes[:'encryption_kp']
+      end
+
+      if attributes.key?(:'sign_assertion')
+        self.sign_assertion = attributes[:'sign_assertion']
+      end
+
+      if attributes.key?(:'sign_logout_request')
+        self.sign_logout_request = attributes[:'sign_logout_request']
+      end
+
+      if attributes.key?(:'default_name_id_policy')
+        self.default_name_id_policy = attributes[:'default_name_id_policy']
+      end
+
+      if attributes.key?(:'url_download_metadata')
+        self.url_download_metadata = attributes[:'url_download_metadata']
+      else
+        self.url_download_metadata = nil
+      end
+
+      if attributes.key?(:'url_wsfed')
+        self.url_wsfed = attributes[:'url_wsfed']
+      else
+        self.url_wsfed = nil
+      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 @pk.nil?
+        invalid_properties.push('invalid value for "pk", pk cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @authorization_flow.nil?
+        invalid_properties.push('invalid value for "authorization_flow", authorization_flow cannot be nil.')
+      end
+
+      if @invalidation_flow.nil?
+        invalid_properties.push('invalid value for "invalidation_flow", invalidation_flow cannot be nil.')
+      end
+
+      if @component.nil?
+        invalid_properties.push('invalid value for "component", component cannot be nil.')
+      end
+
+      if @verbose_name.nil?
+        invalid_properties.push('invalid value for "verbose_name", verbose_name cannot be nil.')
+      end
+
+      if @verbose_name_plural.nil?
+        invalid_properties.push('invalid value for "verbose_name_plural", verbose_name_plural cannot be nil.')
+      end
+
+      if @meta_model_name.nil?
+        invalid_properties.push('invalid value for "meta_model_name", meta_model_name cannot be nil.')
+      end
+
+      if @reply_url.nil?
+        invalid_properties.push('invalid value for "reply_url", reply_url cannot be nil.')
+      end
+
+      if @wtrealm.nil?
+        invalid_properties.push('invalid value for "wtrealm", wtrealm cannot be nil.')
+      end
+
+      if @url_download_metadata.nil?
+        invalid_properties.push('invalid value for "url_download_metadata", url_download_metadata cannot be nil.')
+      end
+
+      if @url_wsfed.nil?
+        invalid_properties.push('invalid value for "url_wsfed", url_wsfed 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 @pk.nil?
+      return false if @name.nil?
+      return false if @authorization_flow.nil?
+      return false if @invalidation_flow.nil?
+      return false if @component.nil?
+      return false if @verbose_name.nil?
+      return false if @verbose_name_plural.nil?
+      return false if @meta_model_name.nil?
+      return false if @reply_url.nil?
+      return false if @wtrealm.nil?
+      return false if @url_download_metadata.nil?
+      return false if @url_wsfed.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pk Value to be assigned
+    def pk=(pk)
+      if pk.nil?
+        fail ArgumentError, 'pk cannot be nil'
+      end
+
+      @pk = pk
+    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
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] authorization_flow Value to be assigned
+    def authorization_flow=(authorization_flow)
+      if authorization_flow.nil?
+        fail ArgumentError, 'authorization_flow cannot be nil'
+      end
+
+      @authorization_flow = authorization_flow
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invalidation_flow Value to be assigned
+    def invalidation_flow=(invalidation_flow)
+      if invalidation_flow.nil?
+        fail ArgumentError, 'invalidation_flow cannot be nil'
+      end
+
+      @invalidation_flow = invalidation_flow
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] component Value to be assigned
+    def component=(component)
+      if component.nil?
+        fail ArgumentError, 'component cannot be nil'
+      end
+
+      @component = component
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] verbose_name Value to be assigned
+    def verbose_name=(verbose_name)
+      if verbose_name.nil?
+        fail ArgumentError, 'verbose_name cannot be nil'
+      end
+
+      @verbose_name = verbose_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] verbose_name_plural Value to be assigned
+    def verbose_name_plural=(verbose_name_plural)
+      if verbose_name_plural.nil?
+        fail ArgumentError, 'verbose_name_plural cannot be nil'
+      end
+
+      @verbose_name_plural = verbose_name_plural
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] meta_model_name Value to be assigned
+    def meta_model_name=(meta_model_name)
+      if meta_model_name.nil?
+        fail ArgumentError, 'meta_model_name cannot be nil'
+      end
+
+      @meta_model_name = meta_model_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reply_url Value to be assigned
+    def reply_url=(reply_url)
+      if reply_url.nil?
+        fail ArgumentError, 'reply_url cannot be nil'
+      end
+
+      @reply_url = reply_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] wtrealm Value to be assigned
+    def wtrealm=(wtrealm)
+      if wtrealm.nil?
+        fail ArgumentError, 'wtrealm cannot be nil'
+      end
+
+      @wtrealm = wtrealm
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url_download_metadata Value to be assigned
+    def url_download_metadata=(url_download_metadata)
+      if url_download_metadata.nil?
+        fail ArgumentError, 'url_download_metadata cannot be nil'
+      end
+
+      @url_download_metadata = url_download_metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url_wsfed Value to be assigned
+    def url_wsfed=(url_wsfed)
+      if url_wsfed.nil?
+        fail ArgumentError, 'url_wsfed cannot be nil'
+      end
+
+      @url_wsfed = url_wsfed
+    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 &&
+          pk == o.pk &&
+          name == o.name &&
+          authentication_flow == o.authentication_flow &&
+          authorization_flow == o.authorization_flow &&
+          invalidation_flow == o.invalidation_flow &&
+          property_mappings == o.property_mappings &&
+          component == o.component &&
+          assigned_application_slug == o.assigned_application_slug &&
+          assigned_application_name == o.assigned_application_name &&
+          assigned_backchannel_application_slug == o.assigned_backchannel_application_slug &&
+          assigned_backchannel_application_name == o.assigned_backchannel_application_name &&
+          verbose_name == o.verbose_name &&
+          verbose_name_plural == o.verbose_name_plural &&
+          meta_model_name == o.meta_model_name &&
+          reply_url == o.reply_url &&
+          wtrealm == o.wtrealm &&
+          assertion_valid_not_before == o.assertion_valid_not_before &&
+          assertion_valid_not_on_or_after == o.assertion_valid_not_on_or_after &&
+          session_valid_not_on_or_after == o.session_valid_not_on_or_after &&
+          name_id_mapping == o.name_id_mapping &&
+          authn_context_class_ref_mapping == o.authn_context_class_ref_mapping &&
+          digest_algorithm == o.digest_algorithm &&
+          signature_algorithm == o.signature_algorithm &&
+          signing_kp == o.signing_kp &&
+          encryption_kp == o.encryption_kp &&
+          sign_assertion == o.sign_assertion &&
+          sign_logout_request == o.sign_logout_request &&
+          default_name_id_policy == o.default_name_id_policy &&
+          url_download_metadata == o.url_download_metadata &&
+          url_wsfed == o.url_wsfed
+    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
+      [pk, name, authentication_flow, authorization_flow, invalidation_flow, property_mappings, component, assigned_application_slug, assigned_application_name, assigned_backchannel_application_slug, assigned_backchannel_application_name, verbose_name, verbose_name_plural, meta_model_name, reply_url, wtrealm, assertion_valid_not_before, assertion_valid_not_on_or_after, session_valid_not_on_or_after, name_id_mapping, authn_context_class_ref_mapping, digest_algorithm, signature_algorithm, signing_kp, encryption_kp, sign_assertion, sign_logout_request, default_name_id_policy, url_download_metadata, url_wsfed].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