authentik-api 2026.8.0.rc6 → 2026.8.0

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

@@ -0,0 +1,214 @@
+=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
+  class PaginatedAgentList < ApiModelBase
+    attr_accessor :pagination
+
+    attr_accessor :results
+
+    attr_accessor :autocomplete
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pagination' => :'pagination',
+        :'results' => :'results',
+        :'autocomplete' => :'autocomplete'
+      }
+    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
+      {
+        :'pagination' => :'Pagination',
+        :'results' => :'Array<Agent>',
+        :'autocomplete' => :'Hash<String, Object>'
+      }
+    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 `Authentik::Api::PaginatedAgentList` 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::PaginatedAgentList`. 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?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      else
+        self.pagination = nil
+      end
+
+      if attributes.key?(:'results')
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = value
+        end
+      else
+        self.results = nil
+      end
+
+      if attributes.key?(:'autocomplete')
+        if (value = attributes[:'autocomplete']).is_a?(Hash)
+          self.autocomplete = value
+        end
+      else
+        self.autocomplete = 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 @pagination.nil?
+        invalid_properties.push('invalid value for "pagination", pagination cannot be nil.')
+      end
+
+      if @results.nil?
+        invalid_properties.push('invalid value for "results", results cannot be nil.')
+      end
+
+      if @autocomplete.nil?
+        invalid_properties.push('invalid value for "autocomplete", autocomplete 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 @pagination.nil?
+      return false if @results.nil?
+      return false if @autocomplete.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pagination Value to be assigned
+    def pagination=(pagination)
+      if pagination.nil?
+        fail ArgumentError, 'pagination cannot be nil'
+      end
+
+      @pagination = pagination
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] results Value to be assigned
+    def results=(results)
+      if results.nil?
+        fail ArgumentError, 'results cannot be nil'
+      end
+
+      @results = results
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] autocomplete Value to be assigned
+    def autocomplete=(autocomplete)
+      if autocomplete.nil?
+        fail ArgumentError, 'autocomplete cannot be nil'
+      end
+
+      @autocomplete = autocomplete
+    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 &&
+          pagination == o.pagination &&
+          results == o.results &&
+          autocomplete == o.autocomplete
+    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
+      [pagination, results, autocomplete].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

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

@@ -0,0 +1,289 @@
+=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
+  # Mixin to validate that a valid enterprise license exists before allowing to save the object
+  class PatchedAgentRequest < ApiModelBase
+    # Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+    attr_accessor :username
+
+    # User's display name.
+    attr_accessor :name
+
+    # Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
+    attr_accessor :is_active
+
+    attr_accessor :last_login
+
+    attr_accessor :email
+
+    attr_accessor :attributes
+
+    attr_accessor :expiring
+
+    attr_accessor :expires
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'username' => :'username',
+        :'name' => :'name',
+        :'is_active' => :'is_active',
+        :'last_login' => :'last_login',
+        :'email' => :'email',
+        :'attributes' => :'attributes',
+        :'expiring' => :'expiring',
+        :'expires' => :'expires'
+      }
+    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
+      {
+        :'username' => :'String',
+        :'name' => :'String',
+        :'is_active' => :'Boolean',
+        :'last_login' => :'Time',
+        :'email' => :'String',
+        :'attributes' => :'Hash<String, Object>',
+        :'expiring' => :'Boolean',
+        :'expires' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'last_login',
+        :'expires'
+      ])
+    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::PatchedAgentRequest` 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::PatchedAgentRequest`. 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?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      end
+
+      if attributes.key?(:'last_login')
+        self.last_login = attributes[:'last_login']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'attributes')
+        if (value = attributes[:'attributes']).is_a?(Hash)
+          self.attributes = value
+        end
+      end
+
+      if attributes.key?(:'expiring')
+        self.expiring = attributes[:'expiring']
+      end
+
+      if attributes.key?(:'expires')
+        self.expires = attributes[:'expires']
+      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 !@username.nil? && @username.to_s.length > 150
+        invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 150.')
+      end
+
+      if !@username.nil? && @username.to_s.length < 1
+        invalid_properties.push('invalid value for "username", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[\w.@+-]+$/)
+      if !@username.nil? && @username !~ pattern
+        invalid_properties.push("invalid value for \"username\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@name.nil? && @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 !@email.nil? && @email.to_s.length > 254
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 254.')
+      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 !@username.nil? && @username.to_s.length > 150
+      return false if !@username.nil? && @username.to_s.length < 1
+      return false if !@username.nil? && @username !~ Regexp.new(/^[\w.@+-]+$/)
+      return false if !@name.nil? && @name.to_s.length < 1
+      return false if !@email.nil? && @email.to_s.length > 254
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] username Value to be assigned
+    def username=(username)
+      if username.nil?
+        fail ArgumentError, 'username cannot be nil'
+      end
+
+      if username.to_s.length > 150
+        fail ArgumentError, 'invalid value for "username", the character length must be smaller than or equal to 150.'
+      end
+
+      if username.to_s.length < 1
+        fail ArgumentError, 'invalid value for "username", the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[\w.@+-]+$/)
+      if username !~ pattern
+        fail ArgumentError, "invalid value for \"username\", must conform to the pattern #{pattern}."
+      end
+
+      @username = username
+    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] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      if email.to_s.length > 254
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 254.'
+      end
+
+      @email = email
+    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 &&
+          username == o.username &&
+          name == o.name &&
+          is_active == o.is_active &&
+          last_login == o.last_login &&
+          email == o.email &&
+          attributes == o.attributes &&
+          expiring == o.expiring &&
+          expires == o.expires
+    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
+      [username, name, is_active, last_login, email, attributes, expiring, expires].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

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

@@ -17,12 +17,16 @@ module Authentik::Api
     # Amount of time a user can take to return from the source to continue the flow (Format: hours=-1;minutes=-2;seconds=-3)
     attr_accessor :resume_timeout
 
+    # Source matching failure reasons for which the flow should resume.
+    attr_accessor :resume_on_match_failures
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'source' => :'source',
-        :'resume_timeout' => :'resume_timeout'
+        :'resume_timeout' => :'resume_timeout',
+        :'resume_on_match_failures' => :'resume_on_match_failures'
       }
     end
 
@@ -41,7 +45,8 @@ module Authentik::Api
       {
         :'name' => :'String',
         :'source' => :'String',
-        :'resume_timeout' => :'String'
+        :'resume_timeout' => :'String',
+        :'resume_on_match_failures' => :'Array<ResumeOnMatchFailuresEnum>'
       }
     end
 
@@ -78,6 +83,12 @@ module Authentik::Api
       if attributes.key?(:'resume_timeout')
         self.resume_timeout = attributes[:'resume_timeout']
       end
+
+      if attributes.key?(:'resume_on_match_failures')
+        if (value = attributes[:'resume_on_match_failures']).is_a?(Array)
+          self.resume_on_match_failures = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -140,7 +151,8 @@ module Authentik::Api
       self.class == o.class &&
           name == o.name &&
           source == o.source &&
-          resume_timeout == o.resume_timeout
+          resume_timeout == o.resume_timeout &&
+          resume_on_match_failures == o.resume_on_match_failures
     end
 
     # @see the `==` method
@@ -152,7 +164,7 @@ module Authentik::Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, source, resume_timeout].hash
+      [name, source, resume_timeout, resume_on_match_failures].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,35 @@
+=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
+  class PolicyBehaviorEnum
+    MIRROR = "mirror".freeze
+    COPY = "copy".freeze
+    NONE = "none".freeze
+
+    def self.all_vars
+      @all_vars ||= [MIRROR, COPY, NONE].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 PolicyBehaviorEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #PolicyBehaviorEnum"
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+=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
+  class ResumeOnMatchFailuresEnum
+    MISSING_PROPERTY = "missing_property".freeze
+
+    def self.all_vars
+      @all_vars ||= [MISSING_PROPERTY].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 ResumeOnMatchFailuresEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ResumeOnMatchFailuresEnum"
+    end
+  end
+end

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

@@ -33,6 +33,9 @@ module Authentik::Api
     # Amount of time a user can take to return from the source to continue the flow (Format: hours=-1;minutes=-2;seconds=-3)
     attr_accessor :resume_timeout
 
+    # Source matching failure reasons for which the flow should resume.
+    attr_accessor :resume_on_match_failures
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -44,7 +47,8 @@ module Authentik::Api
         :'meta_model_name' => :'meta_model_name',
         :'flow_set' => :'flow_set',
         :'source' => :'source',
-        :'resume_timeout' => :'resume_timeout'
+        :'resume_timeout' => :'resume_timeout',
+        :'resume_on_match_failures' => :'resume_on_match_failures'
       }
     end
 
@@ -69,7 +73,8 @@ module Authentik::Api
         :'meta_model_name' => :'String',
         :'flow_set' => :'Array<FlowSet>',
         :'source' => :'String',
-        :'resume_timeout' => :'String'
+        :'resume_timeout' => :'String',
+        :'resume_on_match_failures' => :'Array<ResumeOnMatchFailuresEnum>'
       }
     end
 
@@ -148,6 +153,12 @@ module Authentik::Api
       if attributes.key?(:'resume_timeout')
         self.resume_timeout = attributes[:'resume_timeout']
       end
+
+      if attributes.key?(:'resume_on_match_failures')
+        if (value = attributes[:'resume_on_match_failures']).is_a?(Array)
+          self.resume_on_match_failures = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -298,7 +309,8 @@ module Authentik::Api
           meta_model_name == o.meta_model_name &&
           flow_set == o.flow_set &&
           source == o.source &&
-          resume_timeout == o.resume_timeout
+          resume_timeout == o.resume_timeout &&
+          resume_on_match_failures == o.resume_on_match_failures
     end
 
     # @see the `==` method
@@ -310,7 +322,7 @@ module Authentik::Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pk, name, component, verbose_name, verbose_name_plural, meta_model_name, flow_set, source, resume_timeout].hash
+      [pk, name, component, verbose_name, verbose_name_plural, meta_model_name, flow_set, source, resume_timeout, resume_on_match_failures].hash
     end
 
     # Builds the object from hash