Class: Authentik::Api::FlowsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/authentik/api/api/flows_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FlowsApi

Returns a new instance of FlowsApi.



13
14
15
 
# File 'lib/authentik/api/api/flows_api.rb', line 13

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



11
12
13
 
# File 'lib/authentik/api/api/flows_api.rb', line 11

def api_client
  @api_client
end

Instance Method Details

#flows_bindings_create(flow_stage_binding_request, opts = {}) ⇒ FlowStageBinding

FlowStageBinding Viewset

Parameters:

Returns:



20
21
22
23
 
# File 'lib/authentik/api/api/flows_api.rb', line 20

def flows_bindings_create(flow_stage_binding_request, opts = {})
  data, _status_code, _headers = flows_bindings_create_with_http_info(flow_stage_binding_request, opts)
  data
end

#flows_bindings_create_with_http_info(flow_stage_binding_request, opts = {}) ⇒ Array<(FlowStageBinding, Integer, Hash)>

FlowStageBinding Viewset

Parameters:

Returns:

  • (Array<(FlowStageBinding, Integer, Hash)>) —

    FlowStageBinding data, response status code and response headers



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/authentik/api/api/flows_api.rb', line 29

def flows_bindings_create_with_http_info(flow_stage_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_bindings_create ...'
  end
  # verify the required parameter 'flow_stage_binding_request' is set
  if @api_client.config.client_side_validation && flow_stage_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'flow_stage_binding_request' when calling FlowsApi.flows_bindings_create"
  end
  # resource path
  local_var_path = '/flows/bindings/'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_stage_binding_request)

  # return_type
  return_type = opts[:debug_return_type] || 'FlowStageBinding'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_bindings_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_bindings_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_bindings_destroy(fsb_uuid, opts = {}) ⇒ nil

FlowStageBinding Viewset

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


86
87
88
89
 
# File 'lib/authentik/api/api/flows_api.rb', line 86

def flows_bindings_destroy(fsb_uuid, opts = {})
  flows_bindings_destroy_with_http_info(fsb_uuid, opts)
  nil
end

#flows_bindings_destroy_with_http_info(fsb_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

FlowStageBinding Viewset

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/authentik/api/api/flows_api.rb', line 95

def flows_bindings_destroy_with_http_info(fsb_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_bindings_destroy ...'
  end
  # verify the required parameter 'fsb_uuid' is set
  if @api_client.config.client_side_validation && fsb_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'fsb_uuid' when calling FlowsApi.flows_bindings_destroy"
  end
  # resource path
  local_var_path = '/flows/bindings/{fsb_uuid}/'.sub('{fsb_uuid}', CGI.escape(fsb_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_bindings_destroy",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_bindings_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_bindings_list(opts = {}) ⇒ PaginatedFlowStageBindingList

FlowStageBinding Viewset

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :evaluate_on_plan (Boolean)
  • :fsb_uuid (String)
  • :invalid_response_action (InvalidResponseActionEnum)
  • :order (Integer)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :pbm_uuid (String)
  • :policies (Array<String>)
  • :policy_engine_mode (PolicyEngineMode)
  • :re_evaluate_policies (Boolean)
  • :search (String) —

    A search term.

  • :stage (String)
  • :target (String)

Returns:



160
161
162
163
 
# File 'lib/authentik/api/api/flows_api.rb', line 160

def flows_bindings_list(opts = {})
  data, _status_code, _headers = flows_bindings_list_with_http_info(opts)
  data
end

#flows_bindings_list_with_http_info(opts = {}) ⇒ Array<(PaginatedFlowStageBindingList, Integer, Hash)>

FlowStageBinding Viewset

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :evaluate_on_plan (Boolean)
  • :fsb_uuid (String)
  • :invalid_response_action (InvalidResponseActionEnum)
  • :order (Integer)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :pbm_uuid (String)
  • :policies (Array<String>)
  • :policy_engine_mode (PolicyEngineMode)
  • :re_evaluate_policies (Boolean)
  • :search (String) —

    A search term.

  • :stage (String)
  • :target (String)

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/authentik/api/api/flows_api.rb', line 182

def flows_bindings_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_bindings_list ...'
  end
  # resource path
  local_var_path = '/flows/bindings/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'evaluate_on_plan'] = opts[:'evaluate_on_plan'] if !opts[:'evaluate_on_plan'].nil?
  query_params[:'fsb_uuid'] = opts[:'fsb_uuid'] if !opts[:'fsb_uuid'].nil?
  query_params[:'invalid_response_action'] = opts[:'invalid_response_action'] if !opts[:'invalid_response_action'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'pbm_uuid'] = opts[:'pbm_uuid'] if !opts[:'pbm_uuid'].nil?
  query_params[:'policies'] = @api_client.build_collection_param(opts[:'policies'], :multi) if !opts[:'policies'].nil?
  query_params[:'policy_engine_mode'] = opts[:'policy_engine_mode'] if !opts[:'policy_engine_mode'].nil?
  query_params[:'re_evaluate_policies'] = opts[:'re_evaluate_policies'] if !opts[:'re_evaluate_policies'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'stage'] = opts[:'stage'] if !opts[:'stage'].nil?
  query_params[:'target'] = opts[:'target'] if !opts[:'target'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedFlowStageBindingList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_bindings_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_bindings_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_bindings_partial_update(fsb_uuid, opts = {}) ⇒ FlowStageBinding

FlowStageBinding Viewset

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



245
246
247
248
 
# File 'lib/authentik/api/api/flows_api.rb', line 245

def flows_bindings_partial_update(fsb_uuid, opts = {})
  data, _status_code, _headers = flows_bindings_partial_update_with_http_info(fsb_uuid, opts)
  data
end

#flows_bindings_partial_update_with_http_info(fsb_uuid, opts = {}) ⇒ Array<(FlowStageBinding, Integer, Hash)>

FlowStageBinding Viewset

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FlowStageBinding, Integer, Hash)>) —

    FlowStageBinding data, response status code and response headers



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/authentik/api/api/flows_api.rb', line 255

def flows_bindings_partial_update_with_http_info(fsb_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_bindings_partial_update ...'
  end
  # verify the required parameter 'fsb_uuid' is set
  if @api_client.config.client_side_validation && fsb_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'fsb_uuid' when calling FlowsApi.flows_bindings_partial_update"
  end
  # resource path
  local_var_path = '/flows/bindings/{fsb_uuid}/'.sub('{fsb_uuid}', CGI.escape(fsb_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'patched_flow_stage_binding_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'FlowStageBinding'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_bindings_partial_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_bindings_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_bindings_retrieve(fsb_uuid, opts = {}) ⇒ FlowStageBinding

FlowStageBinding Viewset

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



312
313
314
315
 
# File 'lib/authentik/api/api/flows_api.rb', line 312

def flows_bindings_retrieve(fsb_uuid, opts = {})
  data, _status_code, _headers = flows_bindings_retrieve_with_http_info(fsb_uuid, opts)
  data
end

#flows_bindings_retrieve_with_http_info(fsb_uuid, opts = {}) ⇒ Array<(FlowStageBinding, Integer, Hash)>

FlowStageBinding Viewset

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FlowStageBinding, Integer, Hash)>) —

    FlowStageBinding data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/authentik/api/api/flows_api.rb', line 321

def flows_bindings_retrieve_with_http_info(fsb_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_bindings_retrieve ...'
  end
  # verify the required parameter 'fsb_uuid' is set
  if @api_client.config.client_side_validation && fsb_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'fsb_uuid' when calling FlowsApi.flows_bindings_retrieve"
  end
  # resource path
  local_var_path = '/flows/bindings/{fsb_uuid}/'.sub('{fsb_uuid}', CGI.escape(fsb_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FlowStageBinding'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_bindings_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_bindings_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_bindings_update(fsb_uuid, flow_stage_binding_request, opts = {}) ⇒ FlowStageBinding

FlowStageBinding Viewset

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • flow_stage_binding_request (FlowStageBindingRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



374
375
376
377
 
# File 'lib/authentik/api/api/flows_api.rb', line 374

def flows_bindings_update(fsb_uuid, flow_stage_binding_request, opts = {})
  data, _status_code, _headers = flows_bindings_update_with_http_info(fsb_uuid, flow_stage_binding_request, opts)
  data
end

#flows_bindings_update_with_http_info(fsb_uuid, flow_stage_binding_request, opts = {}) ⇒ Array<(FlowStageBinding, Integer, Hash)>

FlowStageBinding Viewset

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • flow_stage_binding_request (FlowStageBindingRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FlowStageBinding, Integer, Hash)>) —

    FlowStageBinding data, response status code and response headers



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/authentik/api/api/flows_api.rb', line 384

def flows_bindings_update_with_http_info(fsb_uuid, flow_stage_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_bindings_update ...'
  end
  # verify the required parameter 'fsb_uuid' is set
  if @api_client.config.client_side_validation && fsb_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'fsb_uuid' when calling FlowsApi.flows_bindings_update"
  end
  # verify the required parameter 'flow_stage_binding_request' is set
  if @api_client.config.client_side_validation && flow_stage_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'flow_stage_binding_request' when calling FlowsApi.flows_bindings_update"
  end
  # resource path
  local_var_path = '/flows/bindings/{fsb_uuid}/'.sub('{fsb_uuid}', CGI.escape(fsb_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_stage_binding_request)

  # return_type
  return_type = opts[:debug_return_type] || 'FlowStageBinding'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_bindings_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_bindings_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_bindings_used_by_list(fsb_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



445
446
447
448
 
# File 'lib/authentik/api/api/flows_api.rb', line 445

def flows_bindings_used_by_list(fsb_uuid, opts = {})
  data, _status_code, _headers = flows_bindings_used_by_list_with_http_info(fsb_uuid, opts)
  data
end

#flows_bindings_used_by_list_with_http_info(fsb_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • fsb_uuid (String) —

    A UUID string identifying this Flow Stage Binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<UsedBy>, Integer, Hash)>) —

    Array<UsedBy> data, response status code and response headers



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/authentik/api/api/flows_api.rb', line 454

def flows_bindings_used_by_list_with_http_info(fsb_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_bindings_used_by_list ...'
  end
  # verify the required parameter 'fsb_uuid' is set
  if @api_client.config.client_side_validation && fsb_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'fsb_uuid' when calling FlowsApi.flows_bindings_used_by_list"
  end
  # resource path
  local_var_path = '/flows/bindings/{fsb_uuid}/used_by/'.sub('{fsb_uuid}', CGI.escape(fsb_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<UsedBy>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_bindings_used_by_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_bindings_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_executor_get(flow_slug, query, opts = {}) ⇒ ChallengeTypes

Get the next pending challenge from the currently active flow.

Parameters:

  • flow_slug (String)
  • query (String) —

    Querystring as received

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



507
508
509
510
 
# File 'lib/authentik/api/api/flows_api.rb', line 507

def flows_executor_get(flow_slug, query, opts = {})
  data, _status_code, _headers = flows_executor_get_with_http_info(flow_slug, query, opts)
  data
end

#flows_executor_get_with_http_info(flow_slug, query, opts = {}) ⇒ Array<(ChallengeTypes, Integer, Hash)>

Get the next pending challenge from the currently active flow.

Parameters:

  • flow_slug (String)
  • query (String) —

    Querystring as received

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ChallengeTypes, Integer, Hash)>) —

    ChallengeTypes data, response status code and response headers



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/authentik/api/api/flows_api.rb', line 517

def flows_executor_get_with_http_info(flow_slug, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_executor_get ...'
  end
  # verify the required parameter 'flow_slug' is set
  if @api_client.config.client_side_validation && flow_slug.nil?
    fail ArgumentError, "Missing the required parameter 'flow_slug' when calling FlowsApi.flows_executor_get"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling FlowsApi.flows_executor_get"
  end
  # resource path
  local_var_path = '/flows/executor/{flow_slug}/'.sub('{flow_slug}', CGI.escape(flow_slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChallengeTypes'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_executor_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_executor_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_executor_solve(flow_slug, query, opts = {}) ⇒ ChallengeTypes

Solve the previously retrieved challenge and advanced to the next stage.

Parameters:

  • flow_slug (String)
  • query (String) —

    Querystring as received

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



576
577
578
579
 
# File 'lib/authentik/api/api/flows_api.rb', line 576

def flows_executor_solve(flow_slug, query, opts = {})
  data, _status_code, _headers = flows_executor_solve_with_http_info(flow_slug, query, opts)
  data
end

#flows_executor_solve_with_http_info(flow_slug, query, opts = {}) ⇒ Array<(ChallengeTypes, Integer, Hash)>

Solve the previously retrieved challenge and advanced to the next stage.

Parameters:

  • flow_slug (String)
  • query (String) —

    Querystring as received

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ChallengeTypes, Integer, Hash)>) —

    ChallengeTypes data, response status code and response headers



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/authentik/api/api/flows_api.rb', line 587

def flows_executor_solve_with_http_info(flow_slug, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_executor_solve ...'
  end
  # verify the required parameter 'flow_slug' is set
  if @api_client.config.client_side_validation && flow_slug.nil?
    fail ArgumentError, "Missing the required parameter 'flow_slug' when calling FlowsApi.flows_executor_solve"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling FlowsApi.flows_executor_solve"
  end
  # resource path
  local_var_path = '/flows/executor/{flow_slug}/'.sub('{flow_slug}', CGI.escape(flow_slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'flow_challenge_response_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'ChallengeTypes'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_executor_solve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_executor_solve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_inspector_get(flow_slug, opts = {}) ⇒ FlowInspection

Get current flow state and record it

Parameters:

  • flow_slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



649
650
651
652
 
# File 'lib/authentik/api/api/flows_api.rb', line 649

def flows_inspector_get(flow_slug, opts = {})
  data, _status_code, _headers = flows_inspector_get_with_http_info(flow_slug, opts)
  data
end

#flows_inspector_get_with_http_info(flow_slug, opts = {}) ⇒ Array<(FlowInspection, Integer, Hash)>

Get current flow state and record it

Parameters:

  • flow_slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FlowInspection, Integer, Hash)>) —

    FlowInspection data, response status code and response headers



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/authentik/api/api/flows_api.rb', line 658

def flows_inspector_get_with_http_info(flow_slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_inspector_get ...'
  end
  # verify the required parameter 'flow_slug' is set
  if @api_client.config.client_side_validation && flow_slug.nil?
    fail ArgumentError, "Missing the required parameter 'flow_slug' when calling FlowsApi.flows_inspector_get"
  end
  # resource path
  local_var_path = '/flows/inspector/{flow_slug}/'.sub('{flow_slug}', CGI.escape(flow_slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FlowInspection'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_inspector_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_inspector_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_cache_clear_create(opts = {}) ⇒ nil

Clear flow cache

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


709
710
711
712
 
# File 'lib/authentik/api/api/flows_api.rb', line 709

def flows_instances_cache_clear_create(opts = {})
  flows_instances_cache_clear_create_with_http_info(opts)
  nil
end

#flows_instances_cache_clear_create_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Clear flow cache

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/authentik/api/api/flows_api.rb', line 717

def flows_instances_cache_clear_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_cache_clear_create ...'
  end
  # resource path
  local_var_path = '/flows/instances/cache_clear/'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_cache_clear_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_cache_clear_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_cache_info_retrieve(opts = {}) ⇒ Cache

Info about cached flows

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



764
765
766
767
 
# File 'lib/authentik/api/api/flows_api.rb', line 764

def flows_instances_cache_info_retrieve(opts = {})
  data, _status_code, _headers = flows_instances_cache_info_retrieve_with_http_info(opts)
  data
end

#flows_instances_cache_info_retrieve_with_http_info(opts = {}) ⇒ Array<(Cache, Integer, Hash)>

Info about cached flows

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Cache, Integer, Hash)>) —

    Cache data, response status code and response headers



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'lib/authentik/api/api/flows_api.rb', line 772

def flows_instances_cache_info_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_cache_info_retrieve ...'
  end
  # resource path
  local_var_path = '/flows/instances/cache_info/'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Cache'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_cache_info_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_cache_info_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_create(flow_request, opts = {}) ⇒ Flow

Flow Viewset

Parameters:

  • flow_request (FlowRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



820
821
822
823
 
# File 'lib/authentik/api/api/flows_api.rb', line 820

def flows_instances_create(flow_request, opts = {})
  data, _status_code, _headers = flows_instances_create_with_http_info(flow_request, opts)
  data
end

#flows_instances_create_with_http_info(flow_request, opts = {}) ⇒ Array<(Flow, Integer, Hash)>

Flow Viewset

Parameters:

  • flow_request (FlowRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Flow, Integer, Hash)>) —

    Flow data, response status code and response headers



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
 
# File 'lib/authentik/api/api/flows_api.rb', line 829

def flows_instances_create_with_http_info(flow_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_create ...'
  end
  # verify the required parameter 'flow_request' is set
  if @api_client.config.client_side_validation && flow_request.nil?
    fail ArgumentError, "Missing the required parameter 'flow_request' when calling FlowsApi.flows_instances_create"
  end
  # resource path
  local_var_path = '/flows/instances/'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Flow'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_destroy(slug, opts = {}) ⇒ nil

Flow Viewset

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


886
887
888
889
 
# File 'lib/authentik/api/api/flows_api.rb', line 886

def flows_instances_destroy(slug, opts = {})
  flows_instances_destroy_with_http_info(slug, opts)
  nil
end

#flows_instances_destroy_with_http_info(slug, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Flow Viewset

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/authentik/api/api/flows_api.rb', line 895

def flows_instances_destroy_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_destroy ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FlowsApi.flows_instances_destroy"
  end
  # resource path
  local_var_path = '/flows/instances/{slug}/'.sub('{slug}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_destroy",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_diagram_retrieve(slug, opts = {}) ⇒ FlowDiagram

Return diagram for flow with slug ‘slug`, in the format used by flowchart.js

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



947
948
949
950
 
# File 'lib/authentik/api/api/flows_api.rb', line 947

def flows_instances_diagram_retrieve(slug, opts = {})
  data, _status_code, _headers = flows_instances_diagram_retrieve_with_http_info(slug, opts)
  data
end

#flows_instances_diagram_retrieve_with_http_info(slug, opts = {}) ⇒ Array<(FlowDiagram, Integer, Hash)>

Return diagram for flow with slug &#x60;slug&#x60;, in the format used by flowchart.js

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FlowDiagram, Integer, Hash)>) —

    FlowDiagram data, response status code and response headers



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'lib/authentik/api/api/flows_api.rb', line 956

def flows_instances_diagram_retrieve_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_diagram_retrieve ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FlowsApi.flows_instances_diagram_retrieve"
  end
  # resource path
  local_var_path = '/flows/instances/{slug}/diagram/'.sub('{slug}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FlowDiagram'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_diagram_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_diagram_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_execute_retrieve(slug, opts = {}) ⇒ Link

Execute flow for current user

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1008
1009
1010
1011
 
# File 'lib/authentik/api/api/flows_api.rb', line 1008

def flows_instances_execute_retrieve(slug, opts = {})
  data, _status_code, _headers = flows_instances_execute_retrieve_with_http_info(slug, opts)
  data
end

#flows_instances_execute_retrieve_with_http_info(slug, opts = {}) ⇒ Array<(Link, Integer, Hash)>

Execute flow for current user

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Link, Integer, Hash)>) —

    Link data, response status code and response headers



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/authentik/api/api/flows_api.rb', line 1017

def flows_instances_execute_retrieve_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_execute_retrieve ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FlowsApi.flows_instances_execute_retrieve"
  end
  # resource path
  local_var_path = '/flows/instances/{slug}/execute/'.sub('{slug}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Link'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_execute_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_execute_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_export_retrieve(slug, opts = {}) ⇒ File

Export flow to .yaml file

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


1069
1070
1071
1072
 
# File 'lib/authentik/api/api/flows_api.rb', line 1069

def flows_instances_export_retrieve(slug, opts = {})
  data, _status_code, _headers = flows_instances_export_retrieve_with_http_info(slug, opts)
  data
end

#flows_instances_export_retrieve_with_http_info(slug, opts = {}) ⇒ Array<(File, Integer, Hash)>

Export flow to .yaml file

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/authentik/api/api/flows_api.rb', line 1078

def flows_instances_export_retrieve_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_export_retrieve ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FlowsApi.flows_instances_export_retrieve"
  end
  # resource path
  local_var_path = '/flows/instances/{slug}/export/'.sub('{slug}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_export_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_export_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_list(opts = {}) ⇒ PaginatedFlowList

Flow Viewset

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :denied_action (DeniedActionEnum)
  • :designation (FlowDesignationEnum)
  • :flow_uuid (String)
  • :name (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :slug (String)

Returns:



1138
1139
1140
1141
 
# File 'lib/authentik/api/api/flows_api.rb', line 1138

def flows_instances_list(opts = {})
  data, _status_code, _headers = flows_instances_list_with_http_info(opts)
  data
end

#flows_instances_list_with_http_info(opts = {}) ⇒ Array<(PaginatedFlowList, Integer, Hash)>

Flow Viewset

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :denied_action (DeniedActionEnum)
  • :designation (FlowDesignationEnum)
  • :flow_uuid (String)
  • :name (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :slug (String)

Returns:

  • (Array<(PaginatedFlowList, Integer, Hash)>) —

    PaginatedFlowList data, response status code and response headers



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/authentik/api/api/flows_api.rb', line 1155

def flows_instances_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_list ...'
  end
  # resource path
  local_var_path = '/flows/instances/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'denied_action'] = opts[:'denied_action'] if !opts[:'denied_action'].nil?
  query_params[:'designation'] = opts[:'designation'] if !opts[:'designation'].nil?
  query_params[:'flow_uuid'] = opts[:'flow_uuid'] if !opts[:'flow_uuid'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'slug'] = opts[:'slug'] if !opts[:'slug'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedFlowList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_partial_update(slug, opts = {}) ⇒ Flow

Flow Viewset

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1213
1214
1215
1216
 
# File 'lib/authentik/api/api/flows_api.rb', line 1213

def flows_instances_partial_update(slug, opts = {})
  data, _status_code, _headers = flows_instances_partial_update_with_http_info(slug, opts)
  data
end

#flows_instances_partial_update_with_http_info(slug, opts = {}) ⇒ Array<(Flow, Integer, Hash)>

Flow Viewset

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Flow, Integer, Hash)>) —

    Flow data, response status code and response headers



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'lib/authentik/api/api/flows_api.rb', line 1223

def flows_instances_partial_update_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_partial_update ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FlowsApi.flows_instances_partial_update"
  end
  # resource path
  local_var_path = '/flows/instances/{slug}/'.sub('{slug}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'patched_flow_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'Flow'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_partial_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_retrieve(slug, opts = {}) ⇒ Flow

Flow Viewset

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1280
1281
1282
1283
 
# File 'lib/authentik/api/api/flows_api.rb', line 1280

def flows_instances_retrieve(slug, opts = {})
  data, _status_code, _headers = flows_instances_retrieve_with_http_info(slug, opts)
  data
end

#flows_instances_retrieve_with_http_info(slug, opts = {}) ⇒ Array<(Flow, Integer, Hash)>

Flow Viewset

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Flow, Integer, Hash)>) —

    Flow data, response status code and response headers



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/authentik/api/api/flows_api.rb', line 1289

def flows_instances_retrieve_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_retrieve ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FlowsApi.flows_instances_retrieve"
  end
  # resource path
  local_var_path = '/flows/instances/{slug}/'.sub('{slug}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Flow'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_update(slug, flow_request, opts = {}) ⇒ Flow

Flow Viewset

Parameters:

  • slug (String)
  • flow_request (FlowRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1342
1343
1344
1345
 
# File 'lib/authentik/api/api/flows_api.rb', line 1342

def flows_instances_update(slug, flow_request, opts = {})
  data, _status_code, _headers = flows_instances_update_with_http_info(slug, flow_request, opts)
  data
end

#flows_instances_update_with_http_info(slug, flow_request, opts = {}) ⇒ Array<(Flow, Integer, Hash)>

Flow Viewset

Parameters:

  • slug (String)
  • flow_request (FlowRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Flow, Integer, Hash)>) —

    Flow data, response status code and response headers



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'lib/authentik/api/api/flows_api.rb', line 1352

def flows_instances_update_with_http_info(slug, flow_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_update ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FlowsApi.flows_instances_update"
  end
  # verify the required parameter 'flow_request' is set
  if @api_client.config.client_side_validation && flow_request.nil?
    fail ArgumentError, "Missing the required parameter 'flow_request' when calling FlowsApi.flows_instances_update"
  end
  # resource path
  local_var_path = '/flows/instances/{slug}/'.sub('{slug}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Flow'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flows_instances_used_by_list(slug, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1413
1414
1415
1416
 
# File 'lib/authentik/api/api/flows_api.rb', line 1413

def flows_instances_used_by_list(slug, opts = {})
  data, _status_code, _headers = flows_instances_used_by_list_with_http_info(slug, opts)
  data
end

#flows_instances_used_by_list_with_http_info(slug, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • slug (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<UsedBy>, Integer, Hash)>) —

    Array<UsedBy> data, response status code and response headers



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
 
# File 'lib/authentik/api/api/flows_api.rb', line 1422

def flows_instances_used_by_list_with_http_info(slug, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FlowsApi.flows_instances_used_by_list ...'
  end
  # verify the required parameter 'slug' is set
  if @api_client.config.client_side_validation && slug.nil?
    fail ArgumentError, "Missing the required parameter 'slug' when calling FlowsApi.flows_instances_used_by_list"
  end
  # resource path
  local_var_path = '/flows/instances/{slug}/used_by/'.sub('{slug}', CGI.escape(slug.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<UsedBy>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['authentik']

  new_options = opts.merge(
    :operation => :"FlowsApi.flows_instances_used_by_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlowsApi#flows_instances_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end