authentik-api 2026.5.6 → 2026.8.0.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (182) hide show
  1. checksums.yaml +4 -4
  2. data/README_API.md +104 -8
  3. data/lib/authentik/api/api/admin_api.rb +3 -0
  4. data/lib/authentik/api/api/core_api.rb +651 -27
  5. data/lib/authentik/api/api/endpoints_api.rb +7 -7
  6. data/lib/authentik/api/api/events_api.rb +35 -2
  7. data/lib/authentik/api/api/lifecycle_api.rb +258 -0
  8. data/lib/authentik/api/api/providers_api.rb +401 -0
  9. data/lib/authentik/api/api/requests_api.rb +1858 -0
  10. data/lib/authentik/api/api/sources_api.rb +6 -3
  11. data/lib/authentik/api/configuration.rb +14 -0
  12. data/lib/authentik/api/inflector.rb +2 -1
  13. data/lib/authentik/api/models/app_enum.rb +3 -1
  14. data/lib/authentik/api/models/application.rb +27 -1
  15. data/lib/authentik/api/models/authenticator_web_authn_stage.rb +1 -11
  16. data/lib/authentik/api/models/authenticator_web_authn_stage_request.rb +1 -11
  17. data/lib/authentik/api/models/brand.rb +21 -1
  18. data/lib/authentik/api/models/brand_request.rb +21 -1
  19. data/lib/authentik/api/models/captcha_stage.rb +32 -1
  20. data/lib/authentik/api/models/captcha_stage_request.rb +32 -1
  21. data/lib/authentik/api/models/compatibility_mode_enum.rb +2 -1
  22. data/lib/authentik/api/models/content_type.rb +30 -4
  23. data/lib/authentik/api/models/current_brand.rb +19 -1
  24. data/lib/authentik/api/models/current_brand_flags.rb +1 -55
  25. data/lib/authentik/api/models/device_user_binding.rb +39 -1
  26. data/lib/authentik/api/models/event_actions.rb +6 -1
  27. data/lib/authentik/api/models/grant_request.rb +382 -0
  28. data/lib/authentik/api/models/{reviewer_group.rb → grant_request_create_request.rb} +29 -42
  29. data/lib/authentik/api/models/{grant_types_enum.rb → grant_type_enum.rb} +5 -4
  30. data/lib/authentik/api/models/last_task_status_enum.rb +2 -1
  31. data/lib/authentik/api/models/ldap_outpost_config.rb +1 -1
  32. data/lib/authentik/api/models/ldap_source.rb +14 -4
  33. data/lib/authentik/api/models/ldap_source_request.rb +14 -4
  34. data/lib/authentik/api/models/lifecycle_rule.rb +2 -2
  35. data/lib/authentik/api/models/model_enum.rb +8 -1
  36. data/lib/authentik/api/models/notification_mode_enum.rb +35 -0
  37. data/lib/authentik/api/models/o_auth2_dynamic_client_registration.rb +291 -0
  38. data/lib/authentik/api/models/o_auth2_dynamic_client_registration_request.rb +303 -0
  39. data/lib/authentik/api/models/o_auth2_provider.rb +1 -1
  40. data/lib/authentik/api/models/o_auth2_provider_request.rb +1 -1
  41. data/lib/authentik/api/models/o_auth_source.rb +0 -60
  42. data/lib/authentik/api/models/o_auth_source_request.rb +0 -60
  43. data/lib/authentik/api/models/object_attribute.rb +420 -0
  44. data/lib/authentik/api/models/object_attribute_request.rb +358 -0
  45. data/lib/authentik/api/models/object_attribute_type_enum.rb +35 -0
  46. data/lib/authentik/api/models/offboarding_action_enum.rb +34 -0
  47. data/lib/authentik/api/models/offboarding_status_enum.rb +36 -0
  48. data/lib/authentik/api/models/paginated_grant_request_list.rb +214 -0
  49. data/lib/authentik/api/models/paginated_o_auth2_dynamic_client_registration_list.rb +214 -0
  50. data/lib/authentik/api/models/paginated_object_attribute_list.rb +214 -0
  51. data/lib/authentik/api/models/paginated_request_rule_binding_list.rb +214 -0
  52. data/lib/authentik/api/models/paginated_request_rule_child_binding_list.rb +214 -0
  53. data/lib/authentik/api/models/paginated_request_rule_list.rb +214 -0
  54. data/lib/authentik/api/models/paginated_requestable_target_list.rb +214 -0
  55. data/lib/authentik/api/models/paginated_user_offboarding_list.rb +214 -0
  56. data/lib/authentik/api/models/patched_authenticator_web_authn_stage_request.rb +1 -11
  57. data/lib/authentik/api/models/patched_brand_request.rb +21 -1
  58. data/lib/authentik/api/models/patched_captcha_stage_request.rb +32 -1
  59. data/lib/authentik/api/models/patched_grant_request_fulfill_request.rb +175 -0
  60. data/lib/authentik/api/models/patched_ldap_source_request.rb +14 -4
  61. data/lib/authentik/api/models/patched_o_auth2_dynamic_client_registration_request.rb +286 -0
  62. data/lib/authentik/api/models/patched_o_auth2_provider_request.rb +1 -1
  63. data/lib/authentik/api/models/patched_o_auth_source_request.rb +0 -60
  64. data/lib/authentik/api/models/patched_object_attribute_request.rb +320 -0
  65. data/lib/authentik/api/models/patched_request_rule_binding_request.rb +249 -0
  66. data/lib/authentik/api/models/patched_request_rule_child_binding_request.rb +159 -0
  67. data/lib/authentik/api/models/patched_request_rule_request.rb +277 -0
  68. data/lib/authentik/api/models/patched_saml_source_request.rb +8 -8
  69. data/lib/authentik/api/models/patched_settings_request.rb +30 -1
  70. data/lib/authentik/api/models/patched_settings_request_flags.rb +1 -1
  71. data/lib/authentik/api/models/patched_ws_federation_provider_request.rb +11 -1
  72. data/lib/authentik/api/models/policy_binding.rb +42 -4
  73. data/lib/authentik/api/models/provider_type_enum.rb +2 -3
  74. data/lib/authentik/api/models/related_rule.rb +2 -2
  75. data/lib/authentik/api/models/related_target.rb +266 -0
  76. data/lib/authentik/api/models/request_content_type_enum.rb +34 -0
  77. data/lib/authentik/api/models/request_rule.rb +329 -0
  78. data/lib/authentik/api/models/request_rule_binding.rb +353 -0
  79. data/lib/authentik/api/models/request_rule_binding_request.rb +283 -0
  80. data/lib/authentik/api/models/{reviewer_user.rb → request_rule_child_binding.rb} +34 -99
  81. data/lib/authentik/api/models/request_rule_child_binding_request.rb +193 -0
  82. data/lib/authentik/api/models/request_rule_request.rb +284 -0
  83. data/lib/authentik/api/models/request_status.rb +36 -0
  84. data/lib/authentik/api/models/requestable_target.rb +278 -0
  85. data/lib/authentik/api/models/review.rb +1 -1
  86. data/lib/authentik/api/models/saml_source.rb +35 -8
  87. data/lib/authentik/api/models/saml_source_request.rb +8 -8
  88. data/lib/authentik/api/models/saml_version_enum.rb +34 -0
  89. data/lib/authentik/api/models/session_user.rb +32 -4
  90. data/lib/authentik/api/models/settings.rb +30 -1
  91. data/lib/authentik/api/models/settings_request.rb +30 -1
  92. data/lib/authentik/api/models/system_info.rb +31 -4
  93. data/lib/authentik/api/models/task_aggregated_status_enum.rb +2 -1
  94. data/lib/authentik/api/models/task_status_enum.rb +2 -1
  95. data/lib/authentik/api/models/user_offboarding.rb +379 -0
  96. data/lib/authentik/api/models/user_offboarding_request.rb +237 -0
  97. data/lib/authentik/api/models/user_self.rb +28 -1
  98. data/lib/authentik/api/models/user_switch_action_enum.rb +34 -0
  99. data/lib/authentik/api/models/user_switch_request.rb +173 -0
  100. data/lib/authentik/api/models/user_switch_response.rb +159 -0
  101. data/lib/authentik/api/models/ws_federation_provider.rb +41 -4
  102. data/lib/authentik/api/models/ws_federation_provider_request.rb +11 -1
  103. data/lib/authentik/api/version.rb +1 -1
  104. data/spec/api/admin_api_spec.rb +1 -0
  105. data/spec/api/core_api_spec.rb +119 -0
  106. data/spec/api/events_api_spec.rb +11 -0
  107. data/spec/api/lifecycle_api_spec.rb +47 -0
  108. data/spec/api/providers_api_spec.rb +73 -0
  109. data/spec/api/requests_api_spec.rb +365 -0
  110. data/spec/api/sources_api_spec.rb +2 -1
  111. data/spec/models/application_spec.rb +6 -0
  112. data/spec/models/authenticator_web_authn_stage_request_spec.rb +0 -6
  113. data/spec/models/authenticator_web_authn_stage_spec.rb +0 -6
  114. data/spec/models/brand_request_spec.rb +12 -0
  115. data/spec/models/brand_spec.rb +12 -0
  116. data/spec/models/captcha_stage_request_spec.rb +6 -0
  117. data/spec/models/captcha_stage_spec.rb +6 -0
  118. data/spec/models/content_type_spec.rb +6 -0
  119. data/spec/models/current_brand_flags_spec.rb +0 -12
  120. data/spec/models/current_brand_spec.rb +12 -0
  121. data/spec/models/device_user_binding_spec.rb +12 -0
  122. data/spec/models/grant_request_create_request_spec.rb +36 -0
  123. data/spec/models/grant_request_spec.rb +90 -0
  124. data/spec/models/{grant_types_enum_spec.rb → grant_type_enum_spec.rb} +6 -6
  125. data/spec/models/ldap_source_request_spec.rb +6 -0
  126. data/spec/models/ldap_source_spec.rb +6 -0
  127. data/spec/models/notification_mode_enum_spec.rb +24 -0
  128. data/spec/models/o_auth2_dynamic_client_registration_request_spec.rb +78 -0
  129. data/spec/models/o_auth2_dynamic_client_registration_spec.rb +84 -0
  130. data/spec/models/object_attribute_request_spec.rb +84 -0
  131. data/spec/models/object_attribute_spec.rb +108 -0
  132. data/spec/models/object_attribute_type_enum_spec.rb +24 -0
  133. data/spec/models/offboarding_action_enum_spec.rb +24 -0
  134. data/spec/models/offboarding_status_enum_spec.rb +24 -0
  135. data/spec/models/paginated_grant_request_list_spec.rb +42 -0
  136. data/spec/models/paginated_o_auth2_dynamic_client_registration_list_spec.rb +42 -0
  137. data/spec/models/paginated_object_attribute_list_spec.rb +42 -0
  138. data/spec/models/paginated_request_rule_binding_list_spec.rb +42 -0
  139. data/spec/models/paginated_request_rule_child_binding_list_spec.rb +42 -0
  140. data/spec/models/paginated_request_rule_list_spec.rb +42 -0
  141. data/spec/models/paginated_requestable_target_list_spec.rb +42 -0
  142. data/spec/models/paginated_user_offboarding_list_spec.rb +42 -0
  143. data/spec/models/patched_authenticator_web_authn_stage_request_spec.rb +0 -6
  144. data/spec/models/patched_brand_request_spec.rb +12 -0
  145. data/spec/models/patched_captcha_stage_request_spec.rb +6 -0
  146. data/spec/models/patched_grant_request_fulfill_request_spec.rb +36 -0
  147. data/spec/models/patched_ldap_source_request_spec.rb +6 -0
  148. data/spec/models/patched_o_auth2_dynamic_client_registration_request_spec.rb +78 -0
  149. data/spec/models/patched_object_attribute_request_spec.rb +84 -0
  150. data/spec/models/patched_request_rule_binding_request_spec.rb +60 -0
  151. data/spec/models/patched_request_rule_child_binding_request_spec.rb +42 -0
  152. data/spec/models/patched_request_rule_request_spec.rb +72 -0
  153. data/spec/models/patched_saml_source_request_spec.rb +1 -1
  154. data/spec/models/patched_settings_request_spec.rb +6 -0
  155. data/spec/models/patched_ws_federation_provider_request_spec.rb +6 -0
  156. data/spec/models/policy_binding_spec.rb +12 -0
  157. data/spec/models/related_target_spec.rb +54 -0
  158. data/spec/models/request_content_type_enum_spec.rb +24 -0
  159. data/spec/models/request_rule_binding_request_spec.rb +60 -0
  160. data/spec/models/request_rule_binding_spec.rb +84 -0
  161. data/spec/models/request_rule_child_binding_request_spec.rb +42 -0
  162. data/spec/models/{reviewer_user_spec.rb → request_rule_child_binding_spec.rb} +8 -14
  163. data/spec/models/request_rule_request_spec.rb +72 -0
  164. data/spec/models/request_rule_spec.rb +84 -0
  165. data/spec/models/request_status_spec.rb +24 -0
  166. data/spec/models/requestable_target_spec.rb +60 -0
  167. data/spec/models/saml_source_request_spec.rb +1 -1
  168. data/spec/models/saml_source_spec.rb +7 -1
  169. data/spec/models/saml_version_enum_spec.rb +24 -0
  170. data/spec/models/session_user_spec.rb +6 -0
  171. data/spec/models/settings_request_spec.rb +6 -0
  172. data/spec/models/settings_spec.rb +6 -0
  173. data/spec/models/system_info_spec.rb +6 -0
  174. data/spec/models/user_offboarding_request_spec.rb +54 -0
  175. data/spec/models/user_offboarding_spec.rb +90 -0
  176. data/spec/models/user_self_spec.rb +6 -0
  177. data/spec/models/user_switch_action_enum_spec.rb +24 -0
  178. data/spec/models/{reviewer_group_spec.rb → user_switch_request_spec.rb} +8 -8
  179. data/spec/models/user_switch_response_spec.rb +30 -0
  180. data/spec/models/ws_federation_provider_request_spec.rb +6 -0
  181. data/spec/models/ws_federation_provider_spec.rb +12 -0
  182. metadata +127 -10
@@ -49,7 +49,7 @@ module Authentik::Api
49
49
  return_type = opts[:debug_return_type] || 'AgentConfig'
50
50
 
51
51
  # auth_names
52
- auth_names = opts[:debug_auth_names] || []
52
+ auth_names = opts[:debug_auth_names] || ['authentik_device_auth']
53
53
 
54
54
  new_options = opts.merge(
55
55
  :operation => :"EndpointsApi.endpoints_agents_connectors_agent_config_retrieve",
@@ -111,7 +111,7 @@ module Authentik::Api
111
111
  return_type = opts[:debug_return_type] || 'AgentTokenResponse'
112
112
 
113
113
  # auth_names
114
- auth_names = opts[:debug_auth_names] || []
114
+ auth_names = opts[:debug_auth_names] || ['authentik_device_federation']
115
115
 
116
116
  new_options = opts.merge(
117
117
  :operation => :"EndpointsApi.endpoints_agents_connectors_auth_fed_create",
@@ -166,7 +166,7 @@ module Authentik::Api
166
166
  return_type = opts[:debug_return_type] || 'AgentAuthenticationResponse'
167
167
 
168
168
  # auth_names
169
- auth_names = opts[:debug_auth_names] || []
169
+ auth_names = opts[:debug_auth_names] || ['authentik_device_auth']
170
170
 
171
171
  new_options = opts.merge(
172
172
  :operation => :"EndpointsApi.endpoints_agents_connectors_auth_ia_create",
@@ -228,7 +228,7 @@ module Authentik::Api
228
228
  return_type = opts[:debug_return_type]
229
229
 
230
230
  # auth_names
231
- auth_names = opts[:debug_auth_names] || []
231
+ auth_names = opts[:debug_auth_names] || ['authentik_device_auth']
232
232
 
233
233
  new_options = opts.merge(
234
234
  :operation => :"EndpointsApi.endpoints_agents_connectors_check_in_create",
@@ -421,7 +421,7 @@ module Authentik::Api
421
421
  return_type = opts[:debug_return_type] || 'AgentTokenResponse'
422
422
 
423
423
  # auth_names
424
- auth_names = opts[:debug_auth_names] || []
424
+ auth_names = opts[:debug_auth_names] || ['authentik_device_enroll']
425
425
 
426
426
  new_options = opts.merge(
427
427
  :operation => :"EndpointsApi.endpoints_agents_connectors_enroll_create",
@@ -1877,7 +1877,7 @@ module Authentik::Api
1877
1877
  return_type = opts[:debug_return_type] || 'AgentPSSODeviceRegistrationResponse'
1878
1878
 
1879
1879
  # auth_names
1880
- auth_names = opts[:debug_auth_names] || []
1880
+ auth_names = opts[:debug_auth_names] || ['authentik_device_auth']
1881
1881
 
1882
1882
  new_options = opts.merge(
1883
1883
  :operation => :"EndpointsApi.endpoints_agents_psso_register_device_create",
@@ -1941,7 +1941,7 @@ module Authentik::Api
1941
1941
  return_type = opts[:debug_return_type] || 'UserSelf'
1942
1942
 
1943
1943
  # auth_names
1944
- auth_names = opts[:debug_auth_names] || []
1944
+ auth_names = opts[:debug_auth_names] || ['authentik_device_auth']
1945
1945
 
1946
1946
  new_options = opts.merge(
1947
1947
  :operation => :"EndpointsApi.endpoints_agents_psso_register_user_create",
@@ -613,7 +613,18 @@ module Authentik::Api
613
613
  # Get the top_n events grouped by user count
614
614
  # @param [Hash] opts the optional parameters
615
615
  # @option opts [String] :action
616
- # @option opts [Integer] :top_n
616
+ # @option opts [Array<EventActions>] :actions
617
+ # @option opts [String] :brand_name Brand name
618
+ # @option opts [String] :client_ip
619
+ # @option opts [String] :context_authorized_app Context Authorized application
620
+ # @option opts [String] :context_device Context Device Primary Key
621
+ # @option opts [String] :context_model_app Context Model App
622
+ # @option opts [String] :context_model_name Context Model Name
623
+ # @option opts [String] :context_model_pk Context Model Primary Key
624
+ # @option opts [String] :ordering Which field to use when ordering the results.
625
+ # @option opts [String] :search A search term.
626
+ # @option opts [Integer] :top_n (default to 15)
627
+ # @option opts [String] :username Username
617
628
  # @return [Array<EventTopPerUser>]
618
629
  def events_events_top_per_user_list(opts = {})
619
630
  data, _status_code, _headers = events_events_top_per_user_list_with_http_info(opts)
@@ -623,7 +634,18 @@ module Authentik::Api
623
634
  # Get the top_n events grouped by user count
624
635
  # @param [Hash] opts the optional parameters
625
636
  # @option opts [String] :action
626
- # @option opts [Integer] :top_n
637
+ # @option opts [Array<EventActions>] :actions
638
+ # @option opts [String] :brand_name Brand name
639
+ # @option opts [String] :client_ip
640
+ # @option opts [String] :context_authorized_app Context Authorized application
641
+ # @option opts [String] :context_device Context Device Primary Key
642
+ # @option opts [String] :context_model_app Context Model App
643
+ # @option opts [String] :context_model_name Context Model Name
644
+ # @option opts [String] :context_model_pk Context Model Primary Key
645
+ # @option opts [String] :ordering Which field to use when ordering the results.
646
+ # @option opts [String] :search A search term.
647
+ # @option opts [Integer] :top_n (default to 15)
648
+ # @option opts [String] :username Username
627
649
  # @return [Array<(Array<EventTopPerUser>, Integer, Hash)>] Array<EventTopPerUser> data, response status code and response headers
628
650
  def events_events_top_per_user_list_with_http_info(opts = {})
629
651
  if @api_client.config.debugging
@@ -635,7 +657,18 @@ module Authentik::Api
635
657
  # query parameters
636
658
  query_params = opts[:query_params] || {}
637
659
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
660
+ query_params[:'actions'] = @api_client.build_collection_param(opts[:'actions'], :multi) if !opts[:'actions'].nil?
661
+ query_params[:'brand_name'] = opts[:'brand_name'] if !opts[:'brand_name'].nil?
662
+ query_params[:'client_ip'] = opts[:'client_ip'] if !opts[:'client_ip'].nil?
663
+ query_params[:'context_authorized_app'] = opts[:'context_authorized_app'] if !opts[:'context_authorized_app'].nil?
664
+ query_params[:'context_device'] = opts[:'context_device'] if !opts[:'context_device'].nil?
665
+ query_params[:'context_model_app'] = opts[:'context_model_app'] if !opts[:'context_model_app'].nil?
666
+ query_params[:'context_model_name'] = opts[:'context_model_name'] if !opts[:'context_model_name'].nil?
667
+ query_params[:'context_model_pk'] = opts[:'context_model_pk'] if !opts[:'context_model_pk'].nil?
668
+ query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
669
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
638
670
  query_params[:'top_n'] = opts[:'top_n'] if !opts[:'top_n'].nil?
671
+ query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
639
672
 
640
673
  # header parameters
641
674
  header_params = opts[:header_params] || {}
@@ -686,5 +686,263 @@ module Authentik::Api
686
686
  end
687
687
  return data, status_code, headers
688
688
  end
689
+
690
+ # @param user_offboarding_request [UserOffboardingRequest]
691
+ # @param [Hash] opts the optional parameters
692
+ # @return [UserOffboarding]
693
+ def lifecycle_user_offboarding_create(user_offboarding_request, opts = {})
694
+ data, _status_code, _headers = lifecycle_user_offboarding_create_with_http_info(user_offboarding_request, opts)
695
+ data
696
+ end
697
+
698
+ # @param user_offboarding_request [UserOffboardingRequest]
699
+ # @param [Hash] opts the optional parameters
700
+ # @return [Array<(UserOffboarding, Integer, Hash)>] UserOffboarding data, response status code and response headers
701
+ def lifecycle_user_offboarding_create_with_http_info(user_offboarding_request, opts = {})
702
+ if @api_client.config.debugging
703
+ @api_client.config.logger.debug 'Calling API: LifecycleApi.lifecycle_user_offboarding_create ...'
704
+ end
705
+ # verify the required parameter 'user_offboarding_request' is set
706
+ if @api_client.config.client_side_validation && user_offboarding_request.nil?
707
+ fail ArgumentError, "Missing the required parameter 'user_offboarding_request' when calling LifecycleApi.lifecycle_user_offboarding_create"
708
+ end
709
+ # resource path
710
+ local_var_path = '/lifecycle/user_offboarding/'
711
+
712
+ # query parameters
713
+ query_params = opts[:query_params] || {}
714
+
715
+ # header parameters
716
+ header_params = opts[:header_params] || {}
717
+ # HTTP header 'Accept' (if needed)
718
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
719
+ # HTTP header 'Content-Type'
720
+ content_type = @api_client.select_header_content_type(['application/json'])
721
+ if !content_type.nil?
722
+ header_params['Content-Type'] = content_type
723
+ end
724
+
725
+ # form parameters
726
+ form_params = opts[:form_params] || {}
727
+
728
+ # http body (model)
729
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_offboarding_request)
730
+
731
+ # return_type
732
+ return_type = opts[:debug_return_type] || 'UserOffboarding'
733
+
734
+ # auth_names
735
+ auth_names = opts[:debug_auth_names] || ['authentik']
736
+
737
+ new_options = opts.merge(
738
+ :operation => :"LifecycleApi.lifecycle_user_offboarding_create",
739
+ :header_params => header_params,
740
+ :query_params => query_params,
741
+ :form_params => form_params,
742
+ :body => post_body,
743
+ :auth_names => auth_names,
744
+ :return_type => return_type
745
+ )
746
+
747
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
748
+ if @api_client.config.debugging
749
+ @api_client.config.logger.debug "API called: LifecycleApi#lifecycle_user_offboarding_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
750
+ end
751
+ return data, status_code, headers
752
+ end
753
+
754
+ # Cancel a pending offboarding instead of deleting the record. The row is retained (as `CANCELED`) so the offboarding stays visible in the audit history; deletion would erase who scheduled and cancelled it. You cannot cancel an offboarding that targets you.
755
+ # @param id [String] A UUID string identifying this User Offboarding.
756
+ # @param [Hash] opts the optional parameters
757
+ # @return [nil]
758
+ def lifecycle_user_offboarding_destroy(id, opts = {})
759
+ lifecycle_user_offboarding_destroy_with_http_info(id, opts)
760
+ nil
761
+ end
762
+
763
+ # Cancel a pending offboarding instead of deleting the record. The row is retained (as &#x60;CANCELED&#x60;) so the offboarding stays visible in the audit history; deletion would erase who scheduled and cancelled it. You cannot cancel an offboarding that targets you.
764
+ # @param id [String] A UUID string identifying this User Offboarding.
765
+ # @param [Hash] opts the optional parameters
766
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
767
+ def lifecycle_user_offboarding_destroy_with_http_info(id, opts = {})
768
+ if @api_client.config.debugging
769
+ @api_client.config.logger.debug 'Calling API: LifecycleApi.lifecycle_user_offboarding_destroy ...'
770
+ end
771
+ # verify the required parameter 'id' is set
772
+ if @api_client.config.client_side_validation && id.nil?
773
+ fail ArgumentError, "Missing the required parameter 'id' when calling LifecycleApi.lifecycle_user_offboarding_destroy"
774
+ end
775
+ # resource path
776
+ local_var_path = '/lifecycle/user_offboarding/{id}/'.sub('{id}', CGI.escape(id.to_s))
777
+
778
+ # query parameters
779
+ query_params = opts[:query_params] || {}
780
+
781
+ # header parameters
782
+ header_params = opts[:header_params] || {}
783
+ # HTTP header 'Accept' (if needed)
784
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
785
+
786
+ # form parameters
787
+ form_params = opts[:form_params] || {}
788
+
789
+ # http body (model)
790
+ post_body = opts[:debug_body]
791
+
792
+ # return_type
793
+ return_type = opts[:debug_return_type]
794
+
795
+ # auth_names
796
+ auth_names = opts[:debug_auth_names] || ['authentik']
797
+
798
+ new_options = opts.merge(
799
+ :operation => :"LifecycleApi.lifecycle_user_offboarding_destroy",
800
+ :header_params => header_params,
801
+ :query_params => query_params,
802
+ :form_params => form_params,
803
+ :body => post_body,
804
+ :auth_names => auth_names,
805
+ :return_type => return_type
806
+ )
807
+
808
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
809
+ if @api_client.config.debugging
810
+ @api_client.config.logger.debug "API called: LifecycleApi#lifecycle_user_offboarding_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
811
+ end
812
+ return data, status_code, headers
813
+ end
814
+
815
+ # @param [Hash] opts the optional parameters
816
+ # @option opts [OffboardingActionEnum] :action
817
+ # @option opts [String] :ordering Which field to use when ordering the results.
818
+ # @option opts [Integer] :page A page number within the paginated result set.
819
+ # @option opts [Integer] :page_size Number of results to return per page.
820
+ # @option opts [String] :search A search term.
821
+ # @option opts [OffboardingStatusEnum] :status
822
+ # @option opts [String] :user__uuid
823
+ # @return [PaginatedUserOffboardingList]
824
+ def lifecycle_user_offboarding_list(opts = {})
825
+ data, _status_code, _headers = lifecycle_user_offboarding_list_with_http_info(opts)
826
+ data
827
+ end
828
+
829
+ # @param [Hash] opts the optional parameters
830
+ # @option opts [OffboardingActionEnum] :action
831
+ # @option opts [String] :ordering Which field to use when ordering the results.
832
+ # @option opts [Integer] :page A page number within the paginated result set.
833
+ # @option opts [Integer] :page_size Number of results to return per page.
834
+ # @option opts [String] :search A search term.
835
+ # @option opts [OffboardingStatusEnum] :status
836
+ # @option opts [String] :user__uuid
837
+ # @return [Array<(PaginatedUserOffboardingList, Integer, Hash)>] PaginatedUserOffboardingList data, response status code and response headers
838
+ def lifecycle_user_offboarding_list_with_http_info(opts = {})
839
+ if @api_client.config.debugging
840
+ @api_client.config.logger.debug 'Calling API: LifecycleApi.lifecycle_user_offboarding_list ...'
841
+ end
842
+ # resource path
843
+ local_var_path = '/lifecycle/user_offboarding/'
844
+
845
+ # query parameters
846
+ query_params = opts[:query_params] || {}
847
+ query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
848
+ query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
849
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
850
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
851
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
852
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
853
+ query_params[:'user__uuid'] = opts[:'user__uuid'] if !opts[:'user__uuid'].nil?
854
+
855
+ # header parameters
856
+ header_params = opts[:header_params] || {}
857
+ # HTTP header 'Accept' (if needed)
858
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
859
+
860
+ # form parameters
861
+ form_params = opts[:form_params] || {}
862
+
863
+ # http body (model)
864
+ post_body = opts[:debug_body]
865
+
866
+ # return_type
867
+ return_type = opts[:debug_return_type] || 'PaginatedUserOffboardingList'
868
+
869
+ # auth_names
870
+ auth_names = opts[:debug_auth_names] || ['authentik']
871
+
872
+ new_options = opts.merge(
873
+ :operation => :"LifecycleApi.lifecycle_user_offboarding_list",
874
+ :header_params => header_params,
875
+ :query_params => query_params,
876
+ :form_params => form_params,
877
+ :body => post_body,
878
+ :auth_names => auth_names,
879
+ :return_type => return_type
880
+ )
881
+
882
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
883
+ if @api_client.config.debugging
884
+ @api_client.config.logger.debug "API called: LifecycleApi#lifecycle_user_offboarding_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
885
+ end
886
+ return data, status_code, headers
887
+ end
888
+
889
+ # @param id [String] A UUID string identifying this User Offboarding.
890
+ # @param [Hash] opts the optional parameters
891
+ # @return [UserOffboarding]
892
+ def lifecycle_user_offboarding_retrieve(id, opts = {})
893
+ data, _status_code, _headers = lifecycle_user_offboarding_retrieve_with_http_info(id, opts)
894
+ data
895
+ end
896
+
897
+ # @param id [String] A UUID string identifying this User Offboarding.
898
+ # @param [Hash] opts the optional parameters
899
+ # @return [Array<(UserOffboarding, Integer, Hash)>] UserOffboarding data, response status code and response headers
900
+ def lifecycle_user_offboarding_retrieve_with_http_info(id, opts = {})
901
+ if @api_client.config.debugging
902
+ @api_client.config.logger.debug 'Calling API: LifecycleApi.lifecycle_user_offboarding_retrieve ...'
903
+ end
904
+ # verify the required parameter 'id' is set
905
+ if @api_client.config.client_side_validation && id.nil?
906
+ fail ArgumentError, "Missing the required parameter 'id' when calling LifecycleApi.lifecycle_user_offboarding_retrieve"
907
+ end
908
+ # resource path
909
+ local_var_path = '/lifecycle/user_offboarding/{id}/'.sub('{id}', CGI.escape(id.to_s))
910
+
911
+ # query parameters
912
+ query_params = opts[:query_params] || {}
913
+
914
+ # header parameters
915
+ header_params = opts[:header_params] || {}
916
+ # HTTP header 'Accept' (if needed)
917
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
918
+
919
+ # form parameters
920
+ form_params = opts[:form_params] || {}
921
+
922
+ # http body (model)
923
+ post_body = opts[:debug_body]
924
+
925
+ # return_type
926
+ return_type = opts[:debug_return_type] || 'UserOffboarding'
927
+
928
+ # auth_names
929
+ auth_names = opts[:debug_auth_names] || ['authentik']
930
+
931
+ new_options = opts.merge(
932
+ :operation => :"LifecycleApi.lifecycle_user_offboarding_retrieve",
933
+ :header_params => header_params,
934
+ :query_params => query_params,
935
+ :form_params => form_params,
936
+ :body => post_body,
937
+ :auth_names => auth_names,
938
+ :return_type => return_type
939
+ )
940
+
941
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
942
+ if @api_client.config.debugging
943
+ @api_client.config.logger.debug "API called: LifecycleApi#lifecycle_user_offboarding_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
944
+ end
945
+ return data, status_code, headers
946
+ end
689
947
  end
690
948
  end