authentik-api 2026.5.5 → 2026.8.0.rc1

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

@@ -0,0 +1,382 @@
+=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 GrantRequest < ApiModelBase
+    attr_accessor :created
+
+    attr_accessor :created_by
+
+    attr_accessor :requester_data
+
+    attr_accessor :fulfiller_data
+
+    attr_accessor :revoked_by
+
+    attr_accessor :is_active
+
+    attr_accessor :expires
+
+    attr_accessor :status
+
+    attr_accessor :targets
+
+    attr_accessor :target_objs
+
+    attr_accessor :uuid
+
+    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
+      {
+        :'created' => :'created',
+        :'created_by' => :'created_by',
+        :'requester_data' => :'requester_data',
+        :'fulfiller_data' => :'fulfiller_data',
+        :'revoked_by' => :'revoked_by',
+        :'is_active' => :'is_active',
+        :'expires' => :'expires',
+        :'status' => :'status',
+        :'targets' => :'targets',
+        :'target_objs' => :'target_objs',
+        :'uuid' => :'uuid'
+      }
+    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
+      {
+        :'created' => :'Time',
+        :'created_by' => :'PartialUser',
+        :'requester_data' => :'Hash<String, Object>',
+        :'fulfiller_data' => :'Hash<String, Object>',
+        :'revoked_by' => :'PartialUser',
+        :'is_active' => :'Boolean',
+        :'expires' => :'Time',
+        :'status' => :'RequestStatus',
+        :'targets' => :'Array<String>',
+        :'target_objs' => :'Array<RequestableTarget>',
+        :'uuid' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'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::GrantRequest` 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::GrantRequest`. 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?(:'created')
+        self.created = attributes[:'created']
+      else
+        self.created = nil
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      else
+        self.created_by = nil
+      end
+
+      if attributes.key?(:'requester_data')
+        if (value = attributes[:'requester_data']).is_a?(Hash)
+          self.requester_data = value
+        end
+      end
+
+      if attributes.key?(:'fulfiller_data')
+        if (value = attributes[:'fulfiller_data']).is_a?(Hash)
+          self.fulfiller_data = value
+        end
+      end
+
+      if attributes.key?(:'revoked_by')
+        self.revoked_by = attributes[:'revoked_by']
+      else
+        self.revoked_by = nil
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      else
+        self.is_active = nil
+      end
+
+      if attributes.key?(:'expires')
+        self.expires = attributes[:'expires']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'targets')
+        if (value = attributes[:'targets']).is_a?(Array)
+          self.targets = value
+        end
+      else
+        self.targets = nil
+      end
+
+      if attributes.key?(:'target_objs')
+        if (value = attributes[:'target_objs']).is_a?(Array)
+          self.target_objs = value
+        end
+      else
+        self.target_objs = nil
+      end
+
+      if attributes.key?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      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 @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @created_by.nil?
+        invalid_properties.push('invalid value for "created_by", created_by cannot be nil.')
+      end
+
+      if @revoked_by.nil?
+        invalid_properties.push('invalid value for "revoked_by", revoked_by cannot be nil.')
+      end
+
+      if @is_active.nil?
+        invalid_properties.push('invalid value for "is_active", is_active cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @targets.nil?
+        invalid_properties.push('invalid value for "targets", targets cannot be nil.')
+      end
+
+      if @target_objs.nil?
+        invalid_properties.push('invalid value for "target_objs", target_objs 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 @created.nil?
+      return false if @created_by.nil?
+      return false if @revoked_by.nil?
+      return false if @is_active.nil?
+      return false if @status.nil?
+      return false if @targets.nil?
+      return false if @target_objs.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created Value to be assigned
+    def created=(created)
+      if created.nil?
+        fail ArgumentError, 'created cannot be nil'
+      end
+
+      @created = created
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_by Value to be assigned
+    def created_by=(created_by)
+      if created_by.nil?
+        fail ArgumentError, 'created_by cannot be nil'
+      end
+
+      @created_by = created_by
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] revoked_by Value to be assigned
+    def revoked_by=(revoked_by)
+      if revoked_by.nil?
+        fail ArgumentError, 'revoked_by cannot be nil'
+      end
+
+      @revoked_by = revoked_by
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_active Value to be assigned
+    def is_active=(is_active)
+      if is_active.nil?
+        fail ArgumentError, 'is_active cannot be nil'
+      end
+
+      @is_active = is_active
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] targets Value to be assigned
+    def targets=(targets)
+      if targets.nil?
+        fail ArgumentError, 'targets cannot be nil'
+      end
+
+      @targets = targets
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target_objs Value to be assigned
+    def target_objs=(target_objs)
+      if target_objs.nil?
+        fail ArgumentError, 'target_objs cannot be nil'
+      end
+
+      @target_objs = target_objs
+    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 &&
+          created == o.created &&
+          created_by == o.created_by &&
+          requester_data == o.requester_data &&
+          fulfiller_data == o.fulfiller_data &&
+          revoked_by == o.revoked_by &&
+          is_active == o.is_active &&
+          expires == o.expires &&
+          status == o.status &&
+          targets == o.targets &&
+          target_objs == o.target_objs &&
+          uuid == o.uuid
+    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
+      [created, created_by, requester_data, fulfiller_data, revoked_by, is_active, expires, status, targets, target_objs, uuid].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/{reviewer_group.rb → grant_request_create_request.rb}

@@ -8,16 +8,18 @@ require 'date'
 require 'time'
 
 module Authentik::Api
-  class ReviewerGroup < ApiModelBase
-    attr_accessor :pk
+  # Base serializer class which doesn't implement create/update methods
+  class GrantRequestCreateRequest < ApiModelBase
+    attr_accessor :pbms
 
-    attr_accessor :name
+    # Optional override for how long the grant should last once approved. Clamped to the granting rule binding(s)' expiry_granted_max.
+    attr_accessor :expiry
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'pk' => :'pk',
-        :'name' => :'name'
+        :'pbms' => :'pbms',
+        :'expiry' => :'expiry'
       }
     end
 
@@ -34,8 +36,8 @@ module Authentik::Api
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'pk' => :'String',
-        :'name' => :'String'
+        :'pbms' => :'Array<String>',
+        :'expiry' => :'String'
       }
     end
 
@@ -49,28 +51,28 @@ module Authentik::Api
     # @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::ReviewerGroup` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Authentik::Api::GrantRequestCreateRequest` 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::ReviewerGroup`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Authentik::Api::GrantRequestCreateRequest`. 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']
+      if attributes.key?(:'pbms')
+        if (value = attributes[:'pbms']).is_a?(Array)
+          self.pbms = value
+        end
       else
-        self.pk = nil
+        self.pbms = nil
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      else
-        self.name = nil
+      if attributes.key?(:'expiry')
+        self.expiry = attributes[:'expiry']
       end
     end
 
@@ -79,12 +81,8 @@ module Authentik::Api
     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.')
+      if @pbms.nil?
+        invalid_properties.push('invalid value for "pbms", pbms cannot be nil.')
       end
 
       invalid_properties
@@ -94,29 +92,18 @@ module Authentik::Api
     # @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 @pbms.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'
+    # @param [Object] pbms Value to be assigned
+    def pbms=(pbms)
+      if pbms.nil?
+        fail ArgumentError, 'pbms cannot be nil'
       end
 
-      @name = name
+      @pbms = pbms
     end
 
     # Checks equality by comparing each attribute.
@@ -124,8 +111,8 @@ module Authentik::Api
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          pk == o.pk &&
-          name == o.name
+          pbms == o.pbms &&
+          expiry == o.expiry
     end
 
     # @see the `==` method
@@ -137,7 +124,7 @@ module Authentik::Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pk, name].hash
+      [pbms, expiry].hash
     end
 
     # Builds the object from hash

data/lib/authentik/api/models/{grant_types_enum.rb → grant_type_enum.rb}

@@ -8,7 +8,7 @@ require 'date'
 require 'time'
 
 module Authentik::Api
-  class GrantTypesEnum
+  class GrantTypeEnum
     AUTHORIZATION_CODE = "authorization_code".freeze
     IMPLICIT = "implicit".freeze
     HYBRID = "hybrid".freeze
@@ -16,9 +16,10 @@ module Authentik::Api
     CLIENT_CREDENTIALS = "client_credentials".freeze
     PASSWORD = "password".freeze
     URN_IETF_PARAMS_OAUTH_GRANT_TYPE_DEVICE_CODE = "urn:ietf:params:oauth:grant-type:device_code".freeze
+    URN_IETF_PARAMS_OAUTH_GRANT_TYPE_TOKEN_EXCHANGE = "urn:ietf:params:oauth:grant-type:token-exchange".freeze
 
     def self.all_vars
-      @all_vars ||= [AUTHORIZATION_CODE, IMPLICIT, HYBRID, REFRESH_TOKEN, CLIENT_CREDENTIALS, PASSWORD, URN_IETF_PARAMS_OAUTH_GRANT_TYPE_DEVICE_CODE].freeze
+      @all_vars ||= [AUTHORIZATION_CODE, IMPLICIT, HYBRID, REFRESH_TOKEN, CLIENT_CREDENTIALS, PASSWORD, URN_IETF_PARAMS_OAUTH_GRANT_TYPE_DEVICE_CODE, URN_IETF_PARAMS_OAUTH_GRANT_TYPE_TOKEN_EXCHANGE].freeze
     end
 
     # Builds the enum from string
@@ -32,8 +33,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 GrantTypesEnum.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #GrantTypesEnum"
+      return value if GrantTypeEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #GrantTypeEnum"
     end
   end
 end

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

@@ -9,6 +9,7 @@ require 'time'
 
 module Authentik::Api
   class LastTaskStatusEnum
+    WAITING_FOR_DEPENDENCIES = "waiting_for_dependencies".freeze
     QUEUED = "queued".freeze
     CONSUMED = "consumed".freeze
     PREPROCESS = "preprocess".freeze
@@ -21,7 +22,7 @@ module Authentik::Api
     ERROR = "error".freeze
 
     def self.all_vars
-      @all_vars ||= [QUEUED, CONSUMED, PREPROCESS, RUNNING, POSTPROCESS, REJECTED, DONE, INFO, WARNING, ERROR].freeze
+      @all_vars ||= [WAITING_FOR_DEPENDENCIES, QUEUED, CONSUMED, PREPROCESS, RUNNING, POSTPROCESS, REJECTED, DONE, INFO, WARNING, ERROR].freeze
     end
 
     # Builds the enum from string

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

@@ -22,7 +22,7 @@ module Authentik::Api
     # Get slug for unbind flow, defaulting to brand's default flow.
     attr_accessor :unbind_flow_slug
 
-    # Prioritise backchannel slug over direct application slug
+    # Prioritize backchannel slug over direct application slug
     attr_accessor :application_slug
 
     attr_accessor :certificate

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

@@ -122,6 +122,9 @@ module Authentik::Api
     # When to trigger sync for outgoing providers
     attr_accessor :sync_outgoing_trigger_mode
 
+    # Sync group parentage/hierarchy from LDAP directories.
+    attr_accessor :sync_group_hierarchy
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -189,7 +192,8 @@ module Authentik::Api
         :'connectivity' => :'connectivity',
         :'lookup_groups_from_user' => :'lookup_groups_from_user',
         :'delete_not_found_objects' => :'delete_not_found_objects',
-        :'sync_outgoing_trigger_mode' => :'sync_outgoing_trigger_mode'
+        :'sync_outgoing_trigger_mode' => :'sync_outgoing_trigger_mode',
+        :'sync_group_hierarchy' => :'sync_group_hierarchy'
       }
     end
 
@@ -248,7 +252,8 @@ module Authentik::Api
         :'connectivity' => :'Hash<String, Hash<String, String>>',
         :'lookup_groups_from_user' => :'Boolean',
         :'delete_not_found_objects' => :'Boolean',
-        :'sync_outgoing_trigger_mode' => :'SyncOutgoingTriggerModeEnum'
+        :'sync_outgoing_trigger_mode' => :'SyncOutgoingTriggerModeEnum',
+        :'sync_group_hierarchy' => :'Boolean'
       }
     end
 
@@ -485,6 +490,10 @@ module Authentik::Api
       if attributes.key?(:'sync_outgoing_trigger_mode')
         self.sync_outgoing_trigger_mode = attributes[:'sync_outgoing_trigger_mode']
       end
+
+      if attributes.key?(:'sync_group_hierarchy')
+        self.sync_group_hierarchy = attributes[:'sync_group_hierarchy']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -710,7 +719,8 @@ module Authentik::Api
           connectivity == o.connectivity &&
           lookup_groups_from_user == o.lookup_groups_from_user &&
           delete_not_found_objects == o.delete_not_found_objects &&
-          sync_outgoing_trigger_mode == o.sync_outgoing_trigger_mode
+          sync_outgoing_trigger_mode == o.sync_outgoing_trigger_mode &&
+          sync_group_hierarchy == o.sync_group_hierarchy
     end
 
     # @see the `==` method
@@ -722,7 +732,7 @@ module Authentik::Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pk, name, slug, enabled, promoted, authentication_flow, enrollment_flow, user_property_mappings, group_property_mappings, component, verbose_name, verbose_name_plural, meta_model_name, policy_engine_mode, user_matching_mode, managed, user_path_template, icon, icon_url, icon_themed_urls, server_uri, peer_certificate, client_certificate, bind_cn, start_tls, sni, base_dn, additional_user_dn, additional_group_dn, user_object_filter, group_object_filter, group_membership_field, user_membership_attribute, object_uniqueness_field, password_login_update_internal_password, sync_users, sync_users_password, sync_groups, sync_parent_group, connectivity, lookup_groups_from_user, delete_not_found_objects, sync_outgoing_trigger_mode].hash
+      [pk, name, slug, enabled, promoted, authentication_flow, enrollment_flow, user_property_mappings, group_property_mappings, component, verbose_name, verbose_name_plural, meta_model_name, policy_engine_mode, user_matching_mode, managed, user_path_template, icon, icon_url, icon_themed_urls, server_uri, peer_certificate, client_certificate, bind_cn, start_tls, sni, base_dn, additional_user_dn, additional_group_dn, user_object_filter, group_object_filter, group_membership_field, user_membership_attribute, object_uniqueness_field, password_login_update_internal_password, sync_users, sync_users_password, sync_groups, sync_parent_group, connectivity, lookup_groups_from_user, delete_not_found_objects, sync_outgoing_trigger_mode, sync_group_hierarchy].hash
     end
 
     # Builds the object from hash