authentik-api 2026.2.2 → 2026.5.0.rc1

data/spec/api/events_api_spec.rb

@@ -62,10 +62,11 @@ describe 'EventsApi' do
   # Create a data export for this data type. Note that the export is generated asynchronously: this method returns a `DataExport` object that will initially have `completed=false` as well as the permanent URL to that object in the `Location` header. You can poll that URL until `completed=true`, at which point the `file_url` property will contain a URL to download
   # @param [Hash] opts the optional parameters
   # @option opts [String] :action 
-  # @option opts [Array<String>] :actions 
+  # @option opts [Array<EventActions>] :actions 
   # @option opts [String] :brand_name Brand name
   # @option opts [String] :client_ip 
   # @option opts [String] :context_authorized_app Context Authorized application
+  # @option opts [String] :context_device Context Device Primary Key
   # @option opts [String] :context_model_app Context Model App
   # @option opts [String] :context_model_name Context Model Name
   # @option opts [String] :context_model_pk Context Model Primary Key
@@ -83,10 +84,11 @@ describe 'EventsApi' do
   # Event Read-Only Viewset
   # @param [Hash] opts the optional parameters
   # @option opts [String] :action 
-  # @option opts [Array<String>] :actions 
+  # @option opts [Array<EventActions>] :actions 
   # @option opts [String] :brand_name Brand name
   # @option opts [String] :client_ip 
   # @option opts [String] :context_authorized_app Context Authorized application
+  # @option opts [String] :context_device Context Device Primary Key
   # @option opts [String] :context_model_app Context Model App
   # @option opts [String] :context_model_name Context Model Name
   # @option opts [String] :context_model_pk Context Model Primary Key
@@ -125,6 +127,29 @@ describe 'EventsApi' do
     end
   end
 
+  # unit tests for events_events_stats_retrieve
+  # Get event stats for specified filters and count steps
+  # @param count_steps Timedelta, format of &#39;weeks&#x3D;3;days&#x3D;2;hours&#x3D;3,seconds&#x3D;2&#39;
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :action 
+  # @option opts [Array<EventActions>] :actions 
+  # @option opts [String] :brand_name Brand name
+  # @option opts [String] :client_ip 
+  # @option opts [String] :context_authorized_app Context Authorized application
+  # @option opts [String] :context_device Context Device Primary Key
+  # @option opts [String] :context_model_app Context Model App
+  # @option opts [String] :context_model_name Context Model Name
+  # @option opts [String] :context_model_pk Context Model Primary Key
+  # @option opts [String] :ordering Which field to use when ordering the results.
+  # @option opts [String] :search A search term.
+  # @option opts [String] :username Username
+  # @return [EventStats]
+  describe 'events_events_stats_retrieve test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for events_events_top_per_user_list
   # Get the top_n events grouped by user count
   # @param [Hash] opts the optional parameters
@@ -153,14 +178,15 @@ describe 'EventsApi' do
   # Get event volume for specified filters and timeframe
   # @param [Hash] opts the optional parameters
   # @option opts [String] :action 
-  # @option opts [Array<String>] :actions 
+  # @option opts [Array<EventActions>] :actions 
   # @option opts [String] :brand_name Brand name
   # @option opts [String] :client_ip 
   # @option opts [String] :context_authorized_app Context Authorized application
+  # @option opts [String] :context_device Context Device Primary Key
   # @option opts [String] :context_model_app Context Model App
   # @option opts [String] :context_model_name Context Model Name
   # @option opts [String] :context_model_pk Context Model Primary Key
-  # @option opts [Float] :history_days 
+  # @option opts [Integer] :history_days 
   # @option opts [String] :ordering Which field to use when ordering the results.
   # @option opts [String] :search A search term.
   # @option opts [String] :username Username
@@ -193,7 +219,7 @@ describe 'EventsApi' do
   # @option opts [Integer] :page_size Number of results to return per page.
   # @option opts [String] :search A search term.
   # @option opts [Boolean] :seen 
-  # @option opts [String] :severity 
+  # @option opts [SeverityEnum] :severity 
   # @option opts [Integer] :user 
   # @return [PaginatedNotificationList]
   describe 'events_notifications_list test' do
@@ -289,7 +315,7 @@ describe 'EventsApi' do
   # @option opts [Integer] :page A page number within the paginated result set.
   # @option opts [Integer] :page_size Number of results to return per page.
   # @option opts [String] :search A search term.
-  # @option opts [String] :severity Controls which severity level the created notifications will have.  
+  # @option opts [SeverityEnum] :severity 
   # @return [PaginatedNotificationRuleList]
   describe 'events_rules_list test' do
     it 'should work' do
@@ -368,7 +394,7 @@ describe 'EventsApi' do
   # unit tests for events_transports_list
   # NotificationTransport Viewset
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :mode 
+  # @option opts [TransportModeEnum] :mode 
   # @option opts [String] :name 
   # @option opts [String] :ordering Which field to use when ordering the results.
   # @option opts [Integer] :page A page number within the paginated result set.

data/spec/api/flows_api_spec.rb

@@ -53,14 +53,14 @@ describe 'FlowsApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :evaluate_on_plan 
   # @option opts [String] :fsb_uuid 
-  # @option opts [String] :invalid_response_action Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.  
+  # @option opts [InvalidResponseActionEnum] :invalid_response_action 
   # @option opts [Integer] :order 
   # @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.
   # @option opts [String] :pbm_uuid 
   # @option opts [Array<String>] :policies 
-  # @option opts [String] :policy_engine_mode 
+  # @option opts [PolicyEngineMode] :policy_engine_mode 
   # @option opts [Boolean] :re_evaluate_policies 
   # @option opts [String] :search A search term.
   # @option opts [String] :stage 
@@ -229,23 +229,11 @@ describe 'FlowsApi' do
     end
   end
 
-  # unit tests for flows_instances_import_create
-  # Import flow from .yaml file
-  # @param [Hash] opts the optional parameters
-  # @option opts [File] :file 
-  # @option opts [Boolean] :clear 
-  # @return [FlowImportResult]
-  describe 'flows_instances_import_create test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for flows_instances_list
   # Flow Viewset
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :denied_action Configure what should happen when a flow denies access to a user.  
-  # @option opts [String] :designation Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.  
+  # @option opts [DeniedActionEnum] :denied_action 
+  # @option opts [FlowDesignationEnum] :designation 
   # @option opts [String] :flow_uuid 
   # @option opts [String] :name 
   # @option opts [String] :ordering Which field to use when ordering the results.

data/spec/api/lifecycle_api_spec.rb

@@ -37,13 +37,16 @@ describe 'LifecycleApi' do
     end
   end
 
-  # unit tests for lifecycle_iterations_latest_retrieve
+  # unit tests for lifecycle_iterations_list_latest
   # Mixin to validate that a valid enterprise license exists before allowing to save the object
   # @param content_type 
   # @param obj_id 
   # @param [Hash] opts the optional parameters
-  # @return [LifecycleIteration]
-  describe 'lifecycle_iterations_latest_retrieve test' do
+  # @option opts [String] :ordering Which field to use when ordering the results.
+  # @option opts [String] :search A search term.
+  # @option opts [Boolean] :user_is_reviewer 
+  # @return [Array<LifecycleIteration>]
+  describe 'lifecycle_iterations_list_latest test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/api/managed_api_spec.rb

@@ -69,6 +69,19 @@ describe 'ManagedApi' do
     end
   end
 
+  # unit tests for managed_blueprints_import_create
+  # Import blueprint from .yaml file and apply it once, without creating an instance
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :file 
+  # @option opts [String] :path 
+  # @option opts [String] :context 
+  # @return [BlueprintImportResult]
+  describe 'managed_blueprints_import_create test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for managed_blueprints_list
   # Blueprint instances
   # @param [Hash] opts the optional parameters

data/spec/api/policies_api_spec.rb

@@ -321,7 +321,7 @@ describe 'PoliciesApi' do
   # unit tests for policies_event_matcher_list
   # Event Matcher Policy Viewset
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :action Match created events with this action type. When left empty, all action types will be matched.  
+  # @option opts [EventActions] :action 
   # @option opts [String] :app 
   # @option opts [String] :client_ip 
   # @option opts [Time] :created 
@@ -333,6 +333,7 @@ describe 'PoliciesApi' do
   # @option opts [Integer] :page A page number within the paginated result set.
   # @option opts [Integer] :page_size Number of results to return per page.
   # @option opts [String] :policy_uuid 
+  # @option opts [String] :query 
   # @option opts [String] :search A search term.
   # @return [PaginatedEventMatcherPolicyList]
   describe 'policies_event_matcher_list test' do

data/spec/api/providers_api_spec.rb

@@ -667,9 +667,9 @@ describe 'ProvidersApi' do
   # @option opts [String] :application 
   # @option opts [String] :authorization_flow 
   # @option opts [String] :client_id 
-  # @option opts [String] :client_type Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable  
+  # @option opts [ClientTypeEnum] :client_type 
   # @option opts [Boolean] :include_claims_in_id_token 
-  # @option opts [String] :issuer_mode Configure how the issuer field of the ID Token should be filled.  
+  # @option opts [IssuerModeEnum] :issuer_mode 
   # @option opts [String] :name 
   # @option opts [String] :ordering Which field to use when ordering the results.
   # @option opts [Integer] :page A page number within the paginated result set.
@@ -678,7 +678,7 @@ describe 'ProvidersApi' do
   # @option opts [String] :refresh_token_validity 
   # @option opts [String] :search A search term.
   # @option opts [String] :signing_key 
-  # @option opts [String] :sub_mode Configure what data should be used as unique User Identifier. For most cases, the default should be fine.  
+  # @option opts [SubModeEnum] :sub_mode 
   # @return [PaginatedOAuth2ProviderList]
   describe 'providers_oauth2_list test' do
     it 'should work' do
@@ -1069,14 +1069,14 @@ describe 'ProvidersApi' do
   # @option opts [String] :authn_context_class_ref_mapping 
   # @option opts [String] :authorization_flow 
   # @option opts [String] :backchannel_application 
-  # @option opts [String] :default_name_id_policy 
+  # @option opts [SAMLNameIDPolicyEnum] :default_name_id_policy 
   # @option opts [String] :default_relay_state 
-  # @option opts [String] :digest_algorithm 
+  # @option opts [DigestAlgorithmEnum] :digest_algorithm 
   # @option opts [String] :encryption_kp 
   # @option opts [String] :invalidation_flow 
   # @option opts [Boolean] :is_backchannel 
-  # @option opts [String] :issuer 
-  # @option opts [String] :logout_method Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).  
+  # @option opts [String] :issuer_override 
+  # @option opts [SAMLLogoutMethods] :logout_method 
   # @option opts [String] :name 
   # @option opts [String] :name_id_mapping 
   # @option opts [String] :ordering Which field to use when ordering the results.
@@ -1087,12 +1087,13 @@ describe 'ProvidersApi' do
   # @option opts [String] :session_valid_not_on_or_after 
   # @option opts [Boolean] :sign_assertion 
   # @option opts [Boolean] :sign_logout_request 
+  # @option opts [Boolean] :sign_logout_response 
   # @option opts [Boolean] :sign_response 
-  # @option opts [String] :signature_algorithm 
+  # @option opts [SignatureAlgorithmEnum] :signature_algorithm 
   # @option opts [String] :signing_kp 
-  # @option opts [String] :sls_binding This determines how authentik sends the logout response back to the Service Provider.  
+  # @option opts [SAMLBindingsEnum] :sls_binding 
   # @option opts [String] :sls_url 
-  # @option opts [String] :sp_binding This determines how authentik sends the response back to the Service Provider.  
+  # @option opts [SAMLBindingsEnum] :sp_binding 
   # @option opts [String] :verification_kp 
   # @return [PaginatedSAMLProviderList]
   describe 'providers_saml_list test' do
@@ -1106,7 +1107,7 @@ describe 'ProvidersApi' do
   # @param id A unique integer value identifying this SAML Provider.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :download 
-  # @option opts [String] :force_binding Optionally force the metadata to only include one binding.
+  # @option opts [ForceBindingEnum] :force_binding 
   # @return [SAMLMetadata]
   describe 'providers_saml_metadata_retrieve test' do
     it 'should work' do
@@ -1520,14 +1521,14 @@ describe 'ProvidersApi' do
   # @option opts [String] :authn_context_class_ref_mapping 
   # @option opts [String] :authorization_flow 
   # @option opts [String] :backchannel_application 
-  # @option opts [String] :default_name_id_policy 
+  # @option opts [SAMLNameIDPolicyEnum] :default_name_id_policy 
   # @option opts [String] :default_relay_state 
-  # @option opts [String] :digest_algorithm 
+  # @option opts [DigestAlgorithmEnum] :digest_algorithm 
   # @option opts [String] :encryption_kp 
   # @option opts [String] :invalidation_flow 
   # @option opts [Boolean] :is_backchannel 
-  # @option opts [String] :issuer 
-  # @option opts [String] :logout_method Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).  
+  # @option opts [String] :issuer_override 
+  # @option opts [SAMLLogoutMethods] :logout_method 
   # @option opts [String] :name 
   # @option opts [String] :name_id_mapping 
   # @option opts [String] :ordering Which field to use when ordering the results.
@@ -1538,12 +1539,13 @@ describe 'ProvidersApi' do
   # @option opts [String] :session_valid_not_on_or_after 
   # @option opts [Boolean] :sign_assertion 
   # @option opts [Boolean] :sign_logout_request 
+  # @option opts [Boolean] :sign_logout_response 
   # @option opts [Boolean] :sign_response 
-  # @option opts [String] :signature_algorithm 
+  # @option opts [SignatureAlgorithmEnum] :signature_algorithm 
   # @option opts [String] :signing_kp 
-  # @option opts [String] :sls_binding This determines how authentik sends the logout response back to the Service Provider.  
+  # @option opts [SAMLBindingsEnum] :sls_binding 
   # @option opts [String] :sls_url 
-  # @option opts [String] :sp_binding This determines how authentik sends the response back to the Service Provider.  
+  # @option opts [SAMLBindingsEnum] :sp_binding 
   # @option opts [String] :verification_kp 
   # @return [PaginatedWSFederationProviderList]
   describe 'providers_wsfed_list test' do
@@ -1557,7 +1559,7 @@ describe 'ProvidersApi' do
   # @param id A unique integer value identifying this WS-Federation Provider.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :download 
-  # @option opts [String] :force_binding Optionally force the metadata to only include one binding.
+  # @option opts [ForceBindingEnum] :force_binding 
   # @return [SAMLMetadata]
   describe 'providers_wsfed_metadata_retrieve test' do
     it 'should work' do

data/spec/api/schema_api_spec.rb

@@ -29,8 +29,8 @@ describe 'SchemaApi' do
   # unit tests for schema_retrieve
   # OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :format 
-  # @option opts [String] :lang 
+  # @option opts [FormatEnum] :format 
+  # @option opts [LangEnum] :lang 
   # @return [Hash<String, Object>]
   describe 'schema_retrieve test' do
     it 'should work' do

data/spec/api/sources_api_spec.rb

@@ -700,7 +700,7 @@ describe 'SourcesApi' do
   # Kerberos Source Viewset
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :enabled 
-  # @option opts [String] :kadmin_type KAdmin server type  
+  # @option opts [KadminTypeEnum] :kadmin_type 
   # @option opts [String] :name 
   # @option opts [String] :ordering Which field to use when ordering the results.
   # @option opts [Integer] :page A page number within the paginated result set.
@@ -941,20 +941,20 @@ describe 'SourcesApi' do
   # @option opts [String] :consumer_key 
   # @option opts [Boolean] :enabled 
   # @option opts [String] :enrollment_flow 
-  # @option opts [String] :group_matching_mode How the source determines if an existing group should be used or a new group created.  
+  # @option opts [GroupMatchingModeEnum] :group_matching_mode 
   # @option opts [Boolean] :has_jwks Only return sources with JWKS data
   # @option opts [String] :name 
   # @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.
   # @option opts [String] :pbm_uuid 
-  # @option opts [String] :policy_engine_mode 
+  # @option opts [PolicyEngineMode] :policy_engine_mode 
   # @option opts [String] :profile_url 
   # @option opts [String] :provider_type 
   # @option opts [String] :request_token_url 
   # @option opts [String] :search A search term.
   # @option opts [String] :slug 
-  # @option opts [String] :user_matching_mode How the source determines if an existing user should be authenticated or a new user enrolled.  
+  # @option opts [UserMatchingModeEnum] :user_matching_mode 
   # @return [PaginatedOAuthSourceList]
   describe 'sources_oauth_list test' do
     it 'should work' do
@@ -1049,16 +1049,16 @@ describe 'SourcesApi' do
   # @option opts [String] :client_id 
   # @option opts [Boolean] :enabled 
   # @option opts [String] :enrollment_flow 
-  # @option opts [String] :group_matching_mode How the source determines if an existing group should be used or a new group created.  
+  # @option opts [GroupMatchingModeEnum] :group_matching_mode 
   # @option opts [String] :name 
   # @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.
   # @option opts [String] :pbm_uuid 
-  # @option opts [String] :policy_engine_mode 
+  # @option opts [PolicyEngineMode] :policy_engine_mode 
   # @option opts [String] :search A search term.
   # @option opts [String] :slug 
-  # @option opts [String] :user_matching_mode How the source determines if an existing user should be authenticated or a new user enrolled.  
+  # @option opts [UserMatchingModeEnum] :user_matching_mode 
   # @return [PaginatedPlexSourceList]
   describe 'sources_plex_list test' do
     it 'should work' do
@@ -1163,22 +1163,23 @@ describe 'SourcesApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :allow_idp_initiated 
   # @option opts [String] :authentication_flow 
-  # @option opts [String] :binding_type 
-  # @option opts [String] :digest_algorithm 
+  # @option opts [BindingTypeEnum] :binding_type 
+  # @option opts [DigestAlgorithmEnum] :digest_algorithm 
   # @option opts [Boolean] :enabled 
   # @option opts [String] :enrollment_flow 
+  # @option opts [Boolean] :force_authn 
   # @option opts [String] :issuer 
   # @option opts [String] :managed 
   # @option opts [String] :name 
-  # @option opts [String] :name_id_policy NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.  
+  # @option opts [SAMLNameIDPolicyEnum] :name_id_policy 
   # @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.
   # @option opts [String] :pbm_uuid 
-  # @option opts [String] :policy_engine_mode 
+  # @option opts [PolicyEngineMode] :policy_engine_mode 
   # @option opts [String] :pre_authentication_flow 
   # @option opts [String] :search A search term.
-  # @option opts [String] :signature_algorithm 
+  # @option opts [SignatureAlgorithmEnum] :signature_algorithm 
   # @option opts [Boolean] :signed_assertion 
   # @option opts [Boolean] :signed_response 
   # @option opts [String] :signing_kp 
@@ -1186,7 +1187,7 @@ describe 'SourcesApi' do
   # @option opts [String] :slug 
   # @option opts [String] :sso_url 
   # @option opts [String] :temporary_user_delete_after 
-  # @option opts [String] :user_matching_mode How the source determines if an existing user should be authenticated or a new user enrolled.  
+  # @option opts [UserMatchingModeEnum] :user_matching_mode 
   # @option opts [String] :verification_kp 
   # @return [PaginatedSAMLSourceList]
   describe 'sources_saml_list test' do
@@ -1548,17 +1549,17 @@ describe 'SourcesApi' do
   # @option opts [String] :bot_username 
   # @option opts [Boolean] :enabled 
   # @option opts [String] :enrollment_flow 
-  # @option opts [String] :group_matching_mode How the source determines if an existing group should be used or a new group created.  
+  # @option opts [GroupMatchingModeEnum] :group_matching_mode 
   # @option opts [String] :name 
   # @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.
   # @option opts [String] :pbm_uuid 
-  # @option opts [String] :policy_engine_mode 
+  # @option opts [PolicyEngineMode] :policy_engine_mode 
   # @option opts [Boolean] :request_message_access 
   # @option opts [String] :search A search term.
   # @option opts [String] :slug 
-  # @option opts [String] :user_matching_mode How the source determines if an existing user should be authenticated or a new user enrolled.  
+  # @option opts [UserMatchingModeEnum] :user_matching_mode 
   # @return [PaginatedTelegramSourceList]
   describe 'sources_telegram_list test' do
     it 'should work' do

data/spec/api/ssf_api_spec.rb

@@ -26,10 +26,21 @@ describe 'SsfApi' do
     end
   end
 
+  # unit tests for ssf_streams_destroy
+  # SSFStream Viewset
+  # @param uuid A UUID string identifying this SSF Stream.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'ssf_streams_destroy test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for ssf_streams_list
   # SSFStream Viewset
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :delivery_method 
+  # @option opts [DeliveryMethodEnum] :delivery_method 
   # @option opts [String] :endpoint_url 
   # @option opts [String] :ordering Which field to use when ordering the results.
   # @option opts [Integer] :page A page number within the paginated result set.