authentik-api 2025.12.4 → 2026.2.1.1

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

@@ -0,0 +1,258 @@
+=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 ReviewerUser < ApiModelBase
+    attr_accessor :pk
+
+    attr_accessor :uuid
+
+    # Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+    attr_accessor :username
+
+    # User's display name.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pk' => :'pk',
+        :'uuid' => :'uuid',
+        :'username' => :'username',
+        :'name' => :'name'
+      }
+    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',
+        :'uuid' => :'String',
+        :'username' => :'String',
+        :'name' => :'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 `Authentik::Api::ReviewerUser` 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::ReviewerUser`. 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?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      else
+        self.uuid = nil
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      else
+        self.username = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = 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 @uuid.nil?
+        invalid_properties.push('invalid value for "uuid", uuid cannot be nil.')
+      end
+
+      if @username.nil?
+        invalid_properties.push('invalid value for "username", username cannot be nil.')
+      end
+
+      if @username.to_s.length > 150
+        invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 150.')
+      end
+
+      pattern = Regexp.new(/^[\w.@+-]+$/)
+      if @username !~ pattern
+        invalid_properties.push("invalid value for \"username\", must conform to the pattern #{pattern}.")
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", 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 @pk.nil?
+      return false if @uuid.nil?
+      return false if @username.nil?
+      return false if @username.to_s.length > 150
+      return false if @username !~ Regexp.new(/^[\w.@+-]+$/)
+      return false if @name.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] uuid Value to be assigned
+    def uuid=(uuid)
+      if uuid.nil?
+        fail ArgumentError, 'uuid cannot be nil'
+      end
+
+      @uuid = uuid
+    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
+
+      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
+
+      @name = name
+    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 &&
+          uuid == o.uuid &&
+          username == o.username &&
+          name == o.name
+    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, uuid, username, name].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/role.rb

@@ -88,10 +88,6 @@ module Authentik::Api
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
-      if @name.to_s.length > 150
-        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 150.')
-      end
-
       invalid_properties
     end
 
@@ -101,7 +97,6 @@ module Authentik::Api
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @pk.nil?
       return false if @name.nil?
-      return false if @name.to_s.length > 150
       true
     end
 
@@ -122,10 +117,6 @@ module Authentik::Api
         fail ArgumentError, 'name cannot be nil'
       end
 
-      if name.to_s.length > 150
-        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 150.'
-      end
-
       @name = name
     end
 

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

@@ -74,10 +74,6 @@ module Authentik::Api
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
-      if @name.to_s.length > 150
-        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 150.')
-      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
@@ -90,7 +86,6 @@ module Authentik::Api
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @name.nil?
-      return false if @name.to_s.length > 150
       return false if @name.to_s.length < 1
       true
     end
@@ -102,10 +97,6 @@ module Authentik::Api
         fail ArgumentError, 'name cannot be nil'
       end
 
-      if name.to_s.length > 150
-        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 150.'
-      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

data/lib/authentik/api/models/{saml_provider_logout_method_enum.rb → saml_logout_methods.rb}

@@ -8,7 +8,7 @@ require 'date'
 require 'time'
 
 module Authentik::Api
-  class SAMLProviderLogoutMethodEnum
+  class SAMLLogoutMethods
     FRONTCHANNEL_IFRAME = "frontchannel_iframe".freeze
     FRONTCHANNEL_NATIVE = "frontchannel_native".freeze
     BACKCHANNEL = "backchannel".freeze
@@ -28,8 +28,8 @@ module Authentik::Api
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if SAMLProviderLogoutMethodEnum.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #SAMLProviderLogoutMethodEnum"
+      return value if SAMLLogoutMethods.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #SAMLLogoutMethods"
     end
   end
 end

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

@@ -242,7 +242,7 @@ module Authentik::Api
         :'sign_logout_request' => :'Boolean',
         :'sp_binding' => :'SAMLBindingsEnum',
         :'sls_binding' => :'SAMLBindingsEnum',
-        :'logout_method' => :'SAMLProviderLogoutMethodEnum',
+        :'logout_method' => :'SAMLLogoutMethods',
         :'default_relay_state' => :'String',
         :'default_name_id_policy' => :'SAMLNameIDPolicyEnum',
         :'url_download_metadata' => :'String',

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

@@ -174,7 +174,7 @@ module Authentik::Api
         :'sign_logout_request' => :'Boolean',
         :'sp_binding' => :'SAMLBindingsEnum',
         :'sls_binding' => :'SAMLBindingsEnum',
-        :'logout_method' => :'SAMLProviderLogoutMethodEnum',
+        :'logout_method' => :'SAMLLogoutMethods',
         :'default_relay_state' => :'String',
         :'default_name_id_policy' => :'SAMLNameIDPolicyEnum'
       }

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

@@ -61,14 +61,15 @@ module Authentik::Api
 
     attr_accessor :exclude_users_service_account
 
-    attr_accessor :filter_group
-
     # Controls the number of objects synced in a single task
     attr_accessor :sync_page_size
 
     # Timeout for synchronization of a single page
     attr_accessor :sync_page_timeout
 
+    # Group filters used to define sync-scope for groups.
+    attr_accessor :group_filters
+
     # When enabled, provider will not modify or create objects in the remote system.
     attr_accessor :dry_run
 
@@ -116,9 +117,9 @@ module Authentik::Api
         :'compatibility_mode' => :'compatibility_mode',
         :'service_provider_config_cache_timeout' => :'service_provider_config_cache_timeout',
         :'exclude_users_service_account' => :'exclude_users_service_account',
-        :'filter_group' => :'filter_group',
         :'sync_page_size' => :'sync_page_size',
         :'sync_page_timeout' => :'sync_page_timeout',
+        :'group_filters' => :'group_filters',
         :'dry_run' => :'dry_run'
       }
     end
@@ -155,9 +156,9 @@ module Authentik::Api
         :'compatibility_mode' => :'CompatibilityModeEnum',
         :'service_provider_config_cache_timeout' => :'String',
         :'exclude_users_service_account' => :'Boolean',
-        :'filter_group' => :'String',
         :'sync_page_size' => :'Integer',
         :'sync_page_timeout' => :'String',
+        :'group_filters' => :'Array<String>',
         :'dry_run' => :'Boolean'
       }
     end
@@ -168,7 +169,6 @@ module Authentik::Api
         :'assigned_backchannel_application_slug',
         :'assigned_backchannel_application_name',
         :'auth_oauth',
-        :'filter_group',
       ])
     end
 
@@ -288,10 +288,6 @@ module Authentik::Api
         self.exclude_users_service_account = attributes[:'exclude_users_service_account']
       end
 
-      if attributes.key?(:'filter_group')
-        self.filter_group = attributes[:'filter_group']
-      end
-
       if attributes.key?(:'sync_page_size')
         self.sync_page_size = attributes[:'sync_page_size']
       end
@@ -300,6 +296,12 @@ module Authentik::Api
         self.sync_page_timeout = attributes[:'sync_page_timeout']
       end
 
+      if attributes.key?(:'group_filters')
+        if (value = attributes[:'group_filters']).is_a?(Array)
+          self.group_filters = value
+        end
+      end
+
       if attributes.key?(:'dry_run')
         self.dry_run = attributes[:'dry_run']
       end
@@ -477,9 +479,9 @@ module Authentik::Api
           compatibility_mode == o.compatibility_mode &&
           service_provider_config_cache_timeout == o.service_provider_config_cache_timeout &&
           exclude_users_service_account == o.exclude_users_service_account &&
-          filter_group == o.filter_group &&
           sync_page_size == o.sync_page_size &&
           sync_page_timeout == o.sync_page_timeout &&
+          group_filters == o.group_filters &&
           dry_run == o.dry_run
     end
 
@@ -492,7 +494,7 @@ module Authentik::Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pk, name, property_mappings, property_mappings_group, component, assigned_backchannel_application_slug, assigned_backchannel_application_name, verbose_name, verbose_name_plural, meta_model_name, url, verify_certificates, token, auth_mode, auth_oauth, auth_oauth_params, compatibility_mode, service_provider_config_cache_timeout, exclude_users_service_account, filter_group, sync_page_size, sync_page_timeout, dry_run].hash
+      [pk, name, property_mappings, property_mappings_group, component, assigned_backchannel_application_slug, assigned_backchannel_application_name, verbose_name, verbose_name_plural, meta_model_name, url, verify_certificates, token, auth_mode, auth_oauth, auth_oauth_params, compatibility_mode, service_provider_config_cache_timeout, exclude_users_service_account, sync_page_size, sync_page_timeout, group_filters, dry_run].hash
     end
 
     # Builds the object from hash

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

@@ -41,14 +41,15 @@ module Authentik::Api
 
     attr_accessor :exclude_users_service_account
 
-    attr_accessor :filter_group
-
     # Controls the number of objects synced in a single task
     attr_accessor :sync_page_size
 
     # Timeout for synchronization of a single page
     attr_accessor :sync_page_timeout
 
+    # Group filters used to define sync-scope for groups.
+    attr_accessor :group_filters
+
     # When enabled, provider will not modify or create objects in the remote system.
     attr_accessor :dry_run
 
@@ -89,9 +90,9 @@ module Authentik::Api
         :'compatibility_mode' => :'compatibility_mode',
         :'service_provider_config_cache_timeout' => :'service_provider_config_cache_timeout',
         :'exclude_users_service_account' => :'exclude_users_service_account',
-        :'filter_group' => :'filter_group',
         :'sync_page_size' => :'sync_page_size',
         :'sync_page_timeout' => :'sync_page_timeout',
+        :'group_filters' => :'group_filters',
         :'dry_run' => :'dry_run'
       }
     end
@@ -121,9 +122,9 @@ module Authentik::Api
         :'compatibility_mode' => :'CompatibilityModeEnum',
         :'service_provider_config_cache_timeout' => :'String',
         :'exclude_users_service_account' => :'Boolean',
-        :'filter_group' => :'String',
         :'sync_page_size' => :'Integer',
         :'sync_page_timeout' => :'String',
+        :'group_filters' => :'Array<String>',
         :'dry_run' => :'Boolean'
       }
     end
@@ -132,7 +133,6 @@ module Authentik::Api
     def self.openapi_nullable
       Set.new([
         :'auth_oauth',
-        :'filter_group',
       ])
     end
 
@@ -210,10 +210,6 @@ module Authentik::Api
         self.exclude_users_service_account = attributes[:'exclude_users_service_account']
       end
 
-      if attributes.key?(:'filter_group')
-        self.filter_group = attributes[:'filter_group']
-      end
-
       if attributes.key?(:'sync_page_size')
         self.sync_page_size = attributes[:'sync_page_size']
       end
@@ -222,6 +218,12 @@ module Authentik::Api
         self.sync_page_timeout = attributes[:'sync_page_timeout']
       end
 
+      if attributes.key?(:'group_filters')
+        if (value = attributes[:'group_filters']).is_a?(Array)
+          self.group_filters = value
+        end
+      end
+
       if attributes.key?(:'dry_run')
         self.dry_run = attributes[:'dry_run']
       end
@@ -373,9 +375,9 @@ module Authentik::Api
           compatibility_mode == o.compatibility_mode &&
           service_provider_config_cache_timeout == o.service_provider_config_cache_timeout &&
           exclude_users_service_account == o.exclude_users_service_account &&
-          filter_group == o.filter_group &&
           sync_page_size == o.sync_page_size &&
           sync_page_timeout == o.sync_page_timeout &&
+          group_filters == o.group_filters &&
           dry_run == o.dry_run
     end
 
@@ -388,7 +390,7 @@ module Authentik::Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, property_mappings, property_mappings_group, url, verify_certificates, token, auth_mode, auth_oauth, auth_oauth_params, compatibility_mode, service_provider_config_cache_timeout, exclude_users_service_account, filter_group, sync_page_size, sync_page_timeout, dry_run].hash
+      [name, property_mappings, property_mappings_group, url, verify_certificates, token, auth_mode, auth_oauth, auth_oauth_params, compatibility_mode, service_provider_config_cache_timeout, exclude_users_service_account, sync_page_size, sync_page_timeout, group_filters, dry_run].hash
     end
 
     # Builds the object from hash

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

@@ -104,7 +104,7 @@ module Authentik::Api
         :'message_id' => :'String',
         :'queue_name' => :'String',
         :'actor_name' => :'String',
-        :'state' => :'StateEnum',
+        :'state' => :'TaskStateEnum',
         :'mtime' => :'Time',
         :'retries' => :'Integer',
         :'eta' => :'Time',

data/lib/authentik/api/models/{state_enum.rb → task_state_enum.rb}

@@ -8,7 +8,7 @@ require 'date'
 require 'time'
 
 module Authentik::Api
-  class StateEnum
+  class TaskStateEnum
     QUEUED = "queued".freeze
     CONSUMED = "consumed".freeze
     PREPROCESS = "preprocess".freeze
@@ -32,8 +32,8 @@ module Authentik::Api
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if StateEnum.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #StateEnum"
+      return value if TaskStateEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #TaskStateEnum"
     end
   end
 end