authentik-api 2026.2.2 → 2026.5.0.rc1

data/lib/authentik/api/api/tasks_api.rb

@@ -118,7 +118,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'id' when calling TasksApi.tasks_schedules_partial_update"
       end
       # resource path
-      local_var_path = '/tasks/schedules/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/tasks/schedules/{id}/'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -182,7 +182,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'id' when calling TasksApi.tasks_schedules_retrieve"
       end
       # resource path
-      local_var_path = '/tasks/schedules/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/tasks/schedules/{id}/'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -243,7 +243,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'id' when calling TasksApi.tasks_schedules_send_create"
       end
       # resource path
-      local_var_path = '/tasks/schedules/{id}/send/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/tasks/schedules/{id}/send/'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -308,7 +308,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'schedule_request' when calling TasksApi.tasks_schedules_update"
       end
       # resource path
-      local_var_path = '/tasks/schedules/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/tasks/schedules/{id}/'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -354,7 +354,7 @@ module Authentik::Api
 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :actor_name 
-    # @option opts [Array<String>] :aggregated_status 
+    # @option opts [Array<TaskAggregatedStatusEnum>] :aggregated_status 
     # @option opts [String] :ordering Which field to use when ordering the results.
     # @option opts [Integer] :page A page number within the paginated result set.
     # @option opts [Integer] :page_size Number of results to return per page.
@@ -364,7 +364,7 @@ module Authentik::Api
     # @option opts [String] :rel_obj_id 
     # @option opts [Boolean] :rel_obj_id__isnull 
     # @option opts [String] :search A search term.
-    # @option opts [String] :state Task status  
+    # @option opts [TaskStatusEnum] :state 
     # @return [PaginatedTaskList]
     def tasks_tasks_list(opts = {})
       data, _status_code, _headers = tasks_tasks_list_with_http_info(opts)
@@ -373,7 +373,7 @@ module Authentik::Api
 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :actor_name 
-    # @option opts [Array<String>] :aggregated_status 
+    # @option opts [Array<TaskAggregatedStatusEnum>] :aggregated_status 
     # @option opts [String] :ordering Which field to use when ordering the results.
     # @option opts [Integer] :page A page number within the paginated result set.
     # @option opts [Integer] :page_size Number of results to return per page.
@@ -383,20 +383,12 @@ module Authentik::Api
     # @option opts [String] :rel_obj_id 
     # @option opts [Boolean] :rel_obj_id__isnull 
     # @option opts [String] :search A search term.
-    # @option opts [String] :state Task status  
+    # @option opts [TaskStatusEnum] :state 
     # @return [Array<(PaginatedTaskList, Integer, Hash)>] PaginatedTaskList data, response status code and response headers
     def tasks_tasks_list_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TasksApi.tasks_tasks_list ...'
       end
-      allowable_values = ["consumed", "done", "error", "info", "postprocess", "preprocess", "queued", "rejected", "running", "warning"]
-      if @api_client.config.client_side_validation && opts[:'aggregated_status'] && !opts[:'aggregated_status'].all? { |item| allowable_values.include?(item) }
-        fail ArgumentError, "invalid value for \"aggregated_status\", must include one of #{allowable_values}"
-      end
-      allowable_values = ["consumed", "done", "postprocess", "preprocess", "queued", "rejected", "running"]
-      if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
-        fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
-      end
       # resource path
       local_var_path = '/tasks/tasks/'
 
@@ -469,7 +461,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'message_id' when calling TasksApi.tasks_tasks_retrieve"
       end
       # resource path
-      local_var_path = '/tasks/tasks/{message_id}/'.sub('{' + 'message_id' + '}', CGI.escape(message_id.to_s))
+      local_var_path = '/tasks/tasks/{message_id}/'.sub('{message_id}', CGI.escape(message_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -530,7 +522,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'message_id' when calling TasksApi.tasks_tasks_retry_create"
       end
       # resource path
-      local_var_path = '/tasks/tasks/{message_id}/retry/'.sub('{' + 'message_id' + '}', CGI.escape(message_id.to_s))
+      local_var_path = '/tasks/tasks/{message_id}/retry/'.sub('{message_id}', CGI.escape(message_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -640,7 +632,7 @@ module Authentik::Api
         @api_client.config.logger.debug 'Calling API: TasksApi.tasks_workers_list ...'
       end
       # resource path
-      local_var_path = '/tasks/workers'
+      local_var_path = '/tasks/workers/'
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/authentik/api/api/tenants_api.rb

@@ -101,7 +101,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'id' when calling TenantsApi.tenants_domains_destroy"
       end
       # resource path
-      local_var_path = '/tenants/domains/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/tenants/domains/{id}/'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -231,7 +231,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'id' when calling TenantsApi.tenants_domains_partial_update"
       end
       # resource path
-      local_var_path = '/tenants/domains/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/tenants/domains/{id}/'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -297,7 +297,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'id' when calling TenantsApi.tenants_domains_retrieve"
       end
       # resource path
-      local_var_path = '/tenants/domains/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/tenants/domains/{id}/'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -364,7 +364,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'domain_request' when calling TenantsApi.tenants_domains_update"
       end
       # resource path
-      local_var_path = '/tenants/domains/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/tenants/domains/{id}/'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -502,7 +502,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'tenant_admin_group_request_request' when calling TenantsApi.tenants_tenants_create_admin_group_create"
       end
       # resource path
-      local_var_path = '/tenants/tenants/{tenant_uuid}/create_admin_group/'.sub('{' + 'tenant_uuid' + '}', CGI.escape(tenant_uuid.to_s))
+      local_var_path = '/tenants/tenants/{tenant_uuid}/create_admin_group/'.sub('{tenant_uuid}', CGI.escape(tenant_uuid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -574,7 +574,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'tenant_recovery_key_request_request' when calling TenantsApi.tenants_tenants_create_recovery_key_create"
       end
       # resource path
-      local_var_path = '/tenants/tenants/{tenant_uuid}/create_recovery_key/'.sub('{' + 'tenant_uuid' + '}', CGI.escape(tenant_uuid.to_s))
+      local_var_path = '/tenants/tenants/{tenant_uuid}/create_recovery_key/'.sub('{tenant_uuid}', CGI.escape(tenant_uuid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -640,7 +640,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'tenant_uuid' when calling TenantsApi.tenants_tenants_destroy"
       end
       # resource path
-      local_var_path = '/tenants/tenants/{tenant_uuid}/'.sub('{' + 'tenant_uuid' + '}', CGI.escape(tenant_uuid.to_s))
+      local_var_path = '/tenants/tenants/{tenant_uuid}/'.sub('{tenant_uuid}', CGI.escape(tenant_uuid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -770,7 +770,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'tenant_uuid' when calling TenantsApi.tenants_tenants_partial_update"
       end
       # resource path
-      local_var_path = '/tenants/tenants/{tenant_uuid}/'.sub('{' + 'tenant_uuid' + '}', CGI.escape(tenant_uuid.to_s))
+      local_var_path = '/tenants/tenants/{tenant_uuid}/'.sub('{tenant_uuid}', CGI.escape(tenant_uuid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -836,7 +836,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'tenant_uuid' when calling TenantsApi.tenants_tenants_retrieve"
       end
       # resource path
-      local_var_path = '/tenants/tenants/{tenant_uuid}/'.sub('{' + 'tenant_uuid' + '}', CGI.escape(tenant_uuid.to_s))
+      local_var_path = '/tenants/tenants/{tenant_uuid}/'.sub('{tenant_uuid}', CGI.escape(tenant_uuid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -903,7 +903,7 @@ module Authentik::Api
         fail ArgumentError, "Missing the required parameter 'tenant_request' when calling TenantsApi.tenants_tenants_update"
       end
       # resource path
-      local_var_path = '/tenants/tenants/{tenant_uuid}/'.sub('{' + 'tenant_uuid' + '}', CGI.escape(tenant_uuid.to_s))
+      local_var_path = '/tenants/tenants/{tenant_uuid}/'.sub('{tenant_uuid}', CGI.escape(tenant_uuid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

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

@@ -0,0 +1,372 @@
+=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
+  # AccountLockdownStage Serializer
+  class AccountLockdownStage < ApiModelBase
+    attr_accessor :pk
+
+    attr_accessor :name
+
+    # Get object type so that we know how to edit the object
+    attr_accessor :component
+
+    # 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 :flow_set
+
+    # Deactivate the user account (set is_active to False)
+    attr_accessor :deactivate_user
+
+    # Set an unusable password for the user
+    attr_accessor :set_unusable_password
+
+    # Delete all active sessions for the user
+    attr_accessor :delete_sessions
+
+    # Revoke all tokens for the user (API, app password, recovery, verification, OAuth)
+    attr_accessor :revoke_tokens
+
+    # Flow to redirect users to after self-service lockdown. This flow should not require authentication since the user's session is deleted.
+    attr_accessor :self_service_completion_flow
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pk' => :'pk',
+        :'name' => :'name',
+        :'component' => :'component',
+        :'verbose_name' => :'verbose_name',
+        :'verbose_name_plural' => :'verbose_name_plural',
+        :'meta_model_name' => :'meta_model_name',
+        :'flow_set' => :'flow_set',
+        :'deactivate_user' => :'deactivate_user',
+        :'set_unusable_password' => :'set_unusable_password',
+        :'delete_sessions' => :'delete_sessions',
+        :'revoke_tokens' => :'revoke_tokens',
+        :'self_service_completion_flow' => :'self_service_completion_flow'
+      }
+    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' => :'String',
+        :'name' => :'String',
+        :'component' => :'String',
+        :'verbose_name' => :'String',
+        :'verbose_name_plural' => :'String',
+        :'meta_model_name' => :'String',
+        :'flow_set' => :'Array<FlowSet>',
+        :'deactivate_user' => :'Boolean',
+        :'set_unusable_password' => :'Boolean',
+        :'delete_sessions' => :'Boolean',
+        :'revoke_tokens' => :'Boolean',
+        :'self_service_completion_flow' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'self_service_completion_flow'
+      ])
+    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::AccountLockdownStage` 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::AccountLockdownStage`. 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?(:'component')
+        self.component = attributes[:'component']
+      else
+        self.component = 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?(:'flow_set')
+        if (value = attributes[:'flow_set']).is_a?(Array)
+          self.flow_set = value
+        end
+      else
+        self.flow_set = nil
+      end
+
+      if attributes.key?(:'deactivate_user')
+        self.deactivate_user = attributes[:'deactivate_user']
+      end
+
+      if attributes.key?(:'set_unusable_password')
+        self.set_unusable_password = attributes[:'set_unusable_password']
+      end
+
+      if attributes.key?(:'delete_sessions')
+        self.delete_sessions = attributes[:'delete_sessions']
+      end
+
+      if attributes.key?(:'revoke_tokens')
+        self.revoke_tokens = attributes[:'revoke_tokens']
+      end
+
+      if attributes.key?(:'self_service_completion_flow')
+        self.self_service_completion_flow = attributes[:'self_service_completion_flow']
+      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 @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 @flow_set.nil?
+        invalid_properties.push('invalid value for "flow_set", flow_set 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 @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 @flow_set.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] 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] flow_set Value to be assigned
+    def flow_set=(flow_set)
+      if flow_set.nil?
+        fail ArgumentError, 'flow_set cannot be nil'
+      end
+
+      @flow_set = flow_set
+    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 &&
+          component == o.component &&
+          verbose_name == o.verbose_name &&
+          verbose_name_plural == o.verbose_name_plural &&
+          meta_model_name == o.meta_model_name &&
+          flow_set == o.flow_set &&
+          deactivate_user == o.deactivate_user &&
+          set_unusable_password == o.set_unusable_password &&
+          delete_sessions == o.delete_sessions &&
+          revoke_tokens == o.revoke_tokens &&
+          self_service_completion_flow == o.self_service_completion_flow
+    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, component, verbose_name, verbose_name_plural, meta_model_name, flow_set, deactivate_user, set_unusable_password, delete_sessions, revoke_tokens, self_service_completion_flow].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