authentik-api 2026.5.6 → 2026.8.0.rc1

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

@@ -0,0 +1,358 @@
+=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 ObjectAttributeRequest < ApiModelBase
+    attr_accessor :object_type
+
+    attr_accessor :enabled
+
+    attr_accessor :key
+
+    attr_accessor :label
+
+    attr_accessor :regex
+
+    attr_accessor :type
+
+    attr_accessor :group
+
+    # Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
+    attr_accessor :managed
+
+    attr_accessor :is_unique
+
+    attr_accessor :is_required
+
+    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
+      {
+        :'object_type' => :'object_type',
+        :'enabled' => :'enabled',
+        :'key' => :'key',
+        :'label' => :'label',
+        :'regex' => :'regex',
+        :'type' => :'type',
+        :'group' => :'group',
+        :'managed' => :'managed',
+        :'is_unique' => :'is_unique',
+        :'is_required' => :'is_required'
+      }
+    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
+      {
+        :'object_type' => :'String',
+        :'enabled' => :'Boolean',
+        :'key' => :'String',
+        :'label' => :'String',
+        :'regex' => :'String',
+        :'type' => :'ObjectAttributeTypeEnum',
+        :'group' => :'String',
+        :'managed' => :'String',
+        :'is_unique' => :'Boolean',
+        :'is_required' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'managed',
+      ])
+    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::ObjectAttributeRequest` 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::ObjectAttributeRequest`. 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?(:'object_type')
+        self.object_type = attributes[:'object_type']
+      else
+        self.object_type = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = true
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      else
+        self.key = nil
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      else
+        self.label = nil
+      end
+
+      if attributes.key?(:'regex')
+        self.regex = attributes[:'regex']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'group')
+        self.group = attributes[:'group']
+      end
+
+      if attributes.key?(:'managed')
+        self.managed = attributes[:'managed']
+      end
+
+      if attributes.key?(:'is_unique')
+        self.is_unique = attributes[:'is_unique']
+      end
+
+      if attributes.key?(:'is_required')
+        self.is_required = attributes[:'is_required']
+      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 @object_type.nil?
+        invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
+      end
+
+      if @object_type.to_s.length < 1
+        invalid_properties.push('invalid value for "object_type", the character length must be greater than or equal to 1.')
+      end
+
+      if @key.nil?
+        invalid_properties.push('invalid value for "key", key cannot be nil.')
+      end
+
+      if @key.to_s.length < 1
+        invalid_properties.push('invalid value for "key", the character length must be greater than or equal to 1.')
+      end
+
+      if @label.nil?
+        invalid_properties.push('invalid value for "label", label cannot be nil.')
+      end
+
+      if @label.to_s.length < 1
+        invalid_properties.push('invalid value for "label", the character length must be greater than or equal to 1.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if !@managed.nil? && @managed.to_s.length < 1
+        invalid_properties.push('invalid value for "managed", 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 @object_type.nil?
+      return false if @object_type.to_s.length < 1
+      return false if @key.nil?
+      return false if @key.to_s.length < 1
+      return false if @label.nil?
+      return false if @label.to_s.length < 1
+      return false if @type.nil?
+      return false if !@managed.nil? && @managed.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] object_type Value to be assigned
+    def object_type=(object_type)
+      if object_type.nil?
+        fail ArgumentError, 'object_type cannot be nil'
+      end
+
+      if object_type.to_s.length < 1
+        fail ArgumentError, 'invalid value for "object_type", the character length must be greater than or equal to 1.'
+      end
+
+      @object_type = object_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key Value to be assigned
+    def key=(key)
+      if key.nil?
+        fail ArgumentError, 'key cannot be nil'
+      end
+
+      if key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "key", the character length must be greater than or equal to 1.'
+      end
+
+      @key = key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] label Value to be assigned
+    def label=(label)
+      if label.nil?
+        fail ArgumentError, 'label cannot be nil'
+      end
+
+      if label.to_s.length < 1
+        fail ArgumentError, 'invalid value for "label", the character length must be greater than or equal to 1.'
+      end
+
+      @label = label
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] managed Value to be assigned
+    def managed=(managed)
+      if !managed.nil? && managed.to_s.length < 1
+        fail ArgumentError, 'invalid value for "managed", the character length must be greater than or equal to 1.'
+      end
+
+      @managed = managed
+    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 &&
+          object_type == o.object_type &&
+          enabled == o.enabled &&
+          key == o.key &&
+          label == o.label &&
+          regex == o.regex &&
+          type == o.type &&
+          group == o.group &&
+          managed == o.managed &&
+          is_unique == o.is_unique &&
+          is_required == o.is_required
+    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
+      [object_type, enabled, key, label, regex, type, group, managed, is_unique, is_required].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/object_attribute_type_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 ObjectAttributeTypeEnum
+    TEXT = "text".freeze
+    NUMBER = "number".freeze
+    BOOLEAN = "boolean".freeze
+
+    def self.all_vars
+      @all_vars ||= [TEXT, NUMBER, BOOLEAN].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 ObjectAttributeTypeEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ObjectAttributeTypeEnum"
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+=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 OffboardingActionEnum
+    DEACTIVATE = "deactivate".freeze
+    DELETE = "delete".freeze
+
+    def self.all_vars
+      @all_vars ||= [DEACTIVATE, DELETE].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 OffboardingActionEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #OffboardingActionEnum"
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+=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 OffboardingStatusEnum
+    PENDING = "pending".freeze
+    COMPLETED = "completed".freeze
+    FAILED = "failed".freeze
+    CANCELED = "canceled".freeze
+
+    def self.all_vars
+      @all_vars ||= [PENDING, COMPLETED, FAILED, CANCELED].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 OffboardingStatusEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #OffboardingStatusEnum"
+    end
+  end
+end

data/lib/authentik/api/models/paginated_grant_request_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 PaginatedGrantRequestList < 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<GrantRequest>',
+        :'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::PaginatedGrantRequestList` 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::PaginatedGrantRequestList`. 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