Class: Authentik::Api::AuthenticatorsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthenticatorsApi

Returns a new instance of AuthenticatorsApi.



13
14
15
 
# File 'lib/authentik/api/api/authenticators_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/authenticators_api.rb', line 11

def api_client
  @api_client
end

Instance Method Details

#authenticators_admin_all_list(opts = {}) ⇒ Array<Device>

Get all devices for current user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user (Integer)

Returns:



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

def authenticators_admin_all_list(opts = {})
  data, _status_code, _headers = authenticators_admin_all_list_with_http_info(opts)
  data
end

#authenticators_admin_all_list_with_http_info(opts = {}) ⇒ Array<(Array<Device>, Integer, Hash)>

Get all devices for current user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user (Integer)

Returns:

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

    Array<Device> 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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 29

def authenticators_admin_all_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_all_list ...'
  end
  # resource path
  local_var_path = '/authenticators/admin/all/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user'] = opts[:'user'] if !opts[:'user'].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] || 'Array<Device>'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_all_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: AuthenticatorsApi#authenticators_admin_all_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_duo_create(duo_device_request, opts = {}) ⇒ DuoDevice

Viewset for Duo authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 78

def authenticators_admin_duo_create(duo_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_duo_create_with_http_info(duo_device_request, opts)
  data
end

#authenticators_admin_duo_create_with_http_info(duo_device_request, opts = {}) ⇒ Array<(DuoDevice, Integer, Hash)>

Viewset for Duo authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:

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

    DuoDevice data, response status code and response headers



87
88
89
90
91
92
93
94
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 87

def authenticators_admin_duo_create_with_http_info(duo_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_duo_create ...'
  end
  # verify the required parameter 'duo_device_request' is set
  if @api_client.config.client_side_validation && duo_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'duo_device_request' when calling AuthenticatorsApi.authenticators_admin_duo_create"
  end
  # resource path
  local_var_path = '/authenticators/admin/duo/'

  # 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(duo_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_duo_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: AuthenticatorsApi#authenticators_admin_duo_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_duo_destroy(id, opts = {}) ⇒ nil

Viewset for Duo authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

  • (nil) 


144
145
146
147
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 144

def authenticators_admin_duo_destroy(id, opts = {})
  authenticators_admin_duo_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for Duo authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 153

def authenticators_admin_duo_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_duo_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_duo_destroy"
  end
  # resource path
  local_var_path = '/authenticators/admin/duo/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_admin_duo_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: AuthenticatorsApi#authenticators_admin_duo_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_duo_list(opts = {}) ⇒ PaginatedDuoDeviceList

Viewset for Duo authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



209
210
211
212
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 209

def authenticators_admin_duo_list(opts = {})
  data, _status_code, _headers = authenticators_admin_duo_list_with_http_info(opts)
  data
end

#authenticators_admin_duo_list_with_http_info(opts = {}) ⇒ Array<(PaginatedDuoDeviceList, Integer, Hash)>

Viewset for Duo authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedDuoDeviceList data, response status code and response headers



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 222

def authenticators_admin_duo_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_duo_list ...'
  end
  # resource path
  local_var_path = '/authenticators/admin/duo/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedDuoDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_duo_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: AuthenticatorsApi#authenticators_admin_duo_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_duo_partial_update(id, opts = {}) ⇒ DuoDevice

Viewset for Duo authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Options Hash (opts):

Returns:



276
277
278
279
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 276

def authenticators_admin_duo_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_admin_duo_partial_update_with_http_info(id, opts)
  data
end

#authenticators_admin_duo_partial_update_with_http_info(id, opts = {}) ⇒ Array<(DuoDevice, Integer, Hash)>

Viewset for Duo authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DuoDevice data, response status code and response headers



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 286

def authenticators_admin_duo_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_duo_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_duo_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/duo/{id}/'.sub('{id}', CGI.escape(id.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_duo_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_duo_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: AuthenticatorsApi#authenticators_admin_duo_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_duo_retrieve(id, opts = {}) ⇒ DuoDevice

Viewset for Duo authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:



343
344
345
346
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 343

def authenticators_admin_duo_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_admin_duo_retrieve_with_http_info(id, opts)
  data
end

#authenticators_admin_duo_retrieve_with_http_info(id, opts = {}) ⇒ Array<(DuoDevice, Integer, Hash)>

Viewset for Duo authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

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

    DuoDevice data, response status code and response headers



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 352

def authenticators_admin_duo_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_duo_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_duo_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/admin/duo/{id}/'.sub('{id}', CGI.escape(id.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] || 'DuoDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_duo_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: AuthenticatorsApi#authenticators_admin_duo_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_duo_update(id, duo_device_request, opts = {}) ⇒ DuoDevice

Viewset for Duo authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:



405
406
407
408
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 405

def authenticators_admin_duo_update(id, duo_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_duo_update_with_http_info(id, duo_device_request, opts)
  data
end

#authenticators_admin_duo_update_with_http_info(id, duo_device_request, opts = {}) ⇒ Array<(DuoDevice, Integer, Hash)>

Viewset for Duo authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

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

    DuoDevice data, response status code and response headers



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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 415

def authenticators_admin_duo_update_with_http_info(id, duo_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_duo_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_duo_update"
  end
  # verify the required parameter 'duo_device_request' is set
  if @api_client.config.client_side_validation && duo_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'duo_device_request' when calling AuthenticatorsApi.authenticators_admin_duo_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/duo/{id}/'.sub('{id}', CGI.escape(id.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(duo_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_duo_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: AuthenticatorsApi#authenticators_admin_duo_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_email_create(email_device_request, opts = {}) ⇒ EmailDevice

Viewset for email authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:



476
477
478
479
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 476

def authenticators_admin_email_create(email_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_email_create_with_http_info(email_device_request, opts)
  data
end

#authenticators_admin_email_create_with_http_info(email_device_request, opts = {}) ⇒ Array<(EmailDevice, Integer, Hash)>

Viewset for email authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:

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

    EmailDevice data, response status code and response headers



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 485

def authenticators_admin_email_create_with_http_info(email_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_email_create ...'
  end
  # verify the required parameter 'email_device_request' is set
  if @api_client.config.client_side_validation && email_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_device_request' when calling AuthenticatorsApi.authenticators_admin_email_create"
  end
  # resource path
  local_var_path = '/authenticators/admin/email/'

  # 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(email_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_email_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: AuthenticatorsApi#authenticators_admin_email_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_email_destroy(id, opts = {}) ⇒ nil

Viewset for email authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

  • (nil) 


542
543
544
545
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 542

def authenticators_admin_email_destroy(id, opts = {})
  authenticators_admin_email_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for email authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 551

def authenticators_admin_email_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_email_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_email_destroy"
  end
  # resource path
  local_var_path = '/authenticators/admin/email/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_admin_email_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: AuthenticatorsApi#authenticators_admin_email_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_email_list(opts = {}) ⇒ PaginatedEmailDeviceList

Viewset for email authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



607
608
609
610
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 607

def authenticators_admin_email_list(opts = {})
  data, _status_code, _headers = authenticators_admin_email_list_with_http_info(opts)
  data
end

#authenticators_admin_email_list_with_http_info(opts = {}) ⇒ Array<(PaginatedEmailDeviceList, Integer, Hash)>

Viewset for email authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedEmailDeviceList data, response status code and response headers



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 620

def authenticators_admin_email_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_email_list ...'
  end
  # resource path
  local_var_path = '/authenticators/admin/email/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedEmailDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_email_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: AuthenticatorsApi#authenticators_admin_email_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_email_partial_update(id, opts = {}) ⇒ EmailDevice

Viewset for email authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Options Hash (opts):

Returns:



674
675
676
677
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 674

def authenticators_admin_email_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_admin_email_partial_update_with_http_info(id, opts)
  data
end

#authenticators_admin_email_partial_update_with_http_info(id, opts = {}) ⇒ Array<(EmailDevice, Integer, Hash)>

Viewset for email authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EmailDevice data, response status code and response headers



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 684

def authenticators_admin_email_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_email_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_email_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/email/{id}/'.sub('{id}', CGI.escape(id.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_email_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_email_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: AuthenticatorsApi#authenticators_admin_email_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_email_retrieve(id, opts = {}) ⇒ EmailDevice

Viewset for email authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:



741
742
743
744
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 741

def authenticators_admin_email_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_admin_email_retrieve_with_http_info(id, opts)
  data
end

#authenticators_admin_email_retrieve_with_http_info(id, opts = {}) ⇒ Array<(EmailDevice, Integer, Hash)>

Viewset for email authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

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

    EmailDevice data, response status code and response headers



750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 750

def authenticators_admin_email_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_email_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_email_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/admin/email/{id}/'.sub('{id}', CGI.escape(id.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] || 'EmailDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_email_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: AuthenticatorsApi#authenticators_admin_email_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_email_update(id, email_device_request, opts = {}) ⇒ EmailDevice

Viewset for email authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:



803
804
805
806
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 803

def authenticators_admin_email_update(id, email_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_email_update_with_http_info(id, email_device_request, opts)
  data
end

#authenticators_admin_email_update_with_http_info(id, email_device_request, opts = {}) ⇒ Array<(EmailDevice, Integer, Hash)>

Viewset for email authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

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

    EmailDevice data, response status code and response headers



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 813

def authenticators_admin_email_update_with_http_info(id, email_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_email_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_email_update"
  end
  # verify the required parameter 'email_device_request' is set
  if @api_client.config.client_side_validation && email_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_device_request' when calling AuthenticatorsApi.authenticators_admin_email_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/email/{id}/'.sub('{id}', CGI.escape(id.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(email_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_email_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: AuthenticatorsApi#authenticators_admin_email_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_endpoint_create(google_endpoint_device_request, opts = {}) ⇒ GoogleEndpointDevice

Viewset for Endpoint authenticator devices (for admins)

Parameters:

Returns:



874
875
876
877
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 874

def authenticators_admin_endpoint_create(google_endpoint_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_endpoint_create_with_http_info(google_endpoint_device_request, opts)
  data
end

#authenticators_admin_endpoint_create_with_http_info(google_endpoint_device_request, opts = {}) ⇒ Array<(GoogleEndpointDevice, Integer, Hash)>

Viewset for Endpoint authenticator devices (for admins)

Parameters:

Returns:

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

    GoogleEndpointDevice data, response status code and response headers



883
884
885
886
887
888
889
890
891
892
893
894
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 883

def authenticators_admin_endpoint_create_with_http_info(google_endpoint_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_endpoint_create ...'
  end
  # verify the required parameter 'google_endpoint_device_request' is set
  if @api_client.config.client_side_validation && google_endpoint_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'google_endpoint_device_request' when calling AuthenticatorsApi.authenticators_admin_endpoint_create"
  end
  # resource path
  local_var_path = '/authenticators/admin/endpoint/'

  # 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(google_endpoint_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_endpoint_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: AuthenticatorsApi#authenticators_admin_endpoint_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_endpoint_destroy(uuid, opts = {}) ⇒ nil

Viewset for Endpoint authenticator devices (for admins)

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:

  • (nil) 


940
941
942
943
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 940

def authenticators_admin_endpoint_destroy(uuid, opts = {})
  authenticators_admin_endpoint_destroy_with_http_info(uuid, opts)
  nil
end

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

Viewset for Endpoint authenticator devices (for admins)

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



949
950
951
952
953
954
955
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 949

def authenticators_admin_endpoint_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_endpoint_destroy ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling AuthenticatorsApi.authenticators_admin_endpoint_destroy"
  end
  # resource path
  local_var_path = '/authenticators/admin/endpoint/{uuid}/'.sub('{uuid}', CGI.escape(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 => :"AuthenticatorsApi.authenticators_admin_endpoint_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: AuthenticatorsApi#authenticators_admin_endpoint_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_endpoint_list(opts = {}) ⇒ PaginatedGoogleEndpointDeviceList

Viewset for Endpoint authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



1005
1006
1007
1008
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1005

def authenticators_admin_endpoint_list(opts = {})
  data, _status_code, _headers = authenticators_admin_endpoint_list_with_http_info(opts)
  data
end

#authenticators_admin_endpoint_list_with_http_info(opts = {}) ⇒ Array<(PaginatedGoogleEndpointDeviceList, Integer, Hash)>

Viewset for Endpoint authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



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
1064
1065
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1018

def authenticators_admin_endpoint_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_endpoint_list ...'
  end
  # resource path
  local_var_path = '/authenticators/admin/endpoint/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedGoogleEndpointDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_endpoint_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: AuthenticatorsApi#authenticators_admin_endpoint_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_endpoint_partial_update(uuid, opts = {}) ⇒ GoogleEndpointDevice

Viewset for Endpoint authenticator devices (for admins)

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Options Hash (opts):

Returns:



1072
1073
1074
1075
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1072

def authenticators_admin_endpoint_partial_update(uuid, opts = {})
  data, _status_code, _headers = authenticators_admin_endpoint_partial_update_with_http_info(uuid, opts)
  data
end

#authenticators_admin_endpoint_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(GoogleEndpointDevice, Integer, Hash)>

Viewset for Endpoint authenticator devices (for admins)

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GoogleEndpointDevice data, response status code and response headers



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
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1082

def authenticators_admin_endpoint_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_endpoint_partial_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling AuthenticatorsApi.authenticators_admin_endpoint_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/endpoint/{uuid}/'.sub('{uuid}', CGI.escape(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_google_endpoint_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_endpoint_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: AuthenticatorsApi#authenticators_admin_endpoint_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_endpoint_retrieve(uuid, opts = {}) ⇒ GoogleEndpointDevice

Viewset for Endpoint authenticator devices (for admins)

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:



1139
1140
1141
1142
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1139

def authenticators_admin_endpoint_retrieve(uuid, opts = {})
  data, _status_code, _headers = authenticators_admin_endpoint_retrieve_with_http_info(uuid, opts)
  data
end

#authenticators_admin_endpoint_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(GoogleEndpointDevice, Integer, Hash)>

Viewset for Endpoint authenticator devices (for admins)

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:

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

    GoogleEndpointDevice data, response status code and response headers



1148
1149
1150
1151
1152
1153
1154
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1148

def authenticators_admin_endpoint_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_endpoint_retrieve ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling AuthenticatorsApi.authenticators_admin_endpoint_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/admin/endpoint/{uuid}/'.sub('{uuid}', CGI.escape(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] || 'GoogleEndpointDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_endpoint_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: AuthenticatorsApi#authenticators_admin_endpoint_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_endpoint_update(uuid, google_endpoint_device_request, opts = {}) ⇒ GoogleEndpointDevice

Viewset for Endpoint authenticator devices (for admins)

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:



1201
1202
1203
1204
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1201

def authenticators_admin_endpoint_update(uuid, google_endpoint_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_endpoint_update_with_http_info(uuid, google_endpoint_device_request, opts)
  data
end

#authenticators_admin_endpoint_update_with_http_info(uuid, google_endpoint_device_request, opts = {}) ⇒ Array<(GoogleEndpointDevice, Integer, Hash)>

Viewset for Endpoint authenticator devices (for admins)

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:

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

    GoogleEndpointDevice data, response status code and response headers



1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1211

def authenticators_admin_endpoint_update_with_http_info(uuid, google_endpoint_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_endpoint_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling AuthenticatorsApi.authenticators_admin_endpoint_update"
  end
  # verify the required parameter 'google_endpoint_device_request' is set
  if @api_client.config.client_side_validation && google_endpoint_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'google_endpoint_device_request' when calling AuthenticatorsApi.authenticators_admin_endpoint_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/endpoint/{uuid}/'.sub('{uuid}', CGI.escape(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(google_endpoint_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_endpoint_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: AuthenticatorsApi#authenticators_admin_endpoint_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_sms_create(sms_device_request, opts = {}) ⇒ SMSDevice

Viewset for sms authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:



1272
1273
1274
1275
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1272

def authenticators_admin_sms_create(sms_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_sms_create_with_http_info(sms_device_request, opts)
  data
end

#authenticators_admin_sms_create_with_http_info(sms_device_request, opts = {}) ⇒ Array<(SMSDevice, Integer, Hash)>

Viewset for sms authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:

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

    SMSDevice data, response status code and response headers



1281
1282
1283
1284
1285
1286
1287
1288
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1281

def authenticators_admin_sms_create_with_http_info(sms_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_sms_create ...'
  end
  # verify the required parameter 'sms_device_request' is set
  if @api_client.config.client_side_validation && sms_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'sms_device_request' when calling AuthenticatorsApi.authenticators_admin_sms_create"
  end
  # resource path
  local_var_path = '/authenticators/admin/sms/'

  # 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(sms_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_sms_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: AuthenticatorsApi#authenticators_admin_sms_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_sms_destroy(id, opts = {}) ⇒ nil

Viewset for sms authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

  • (nil) 


1338
1339
1340
1341
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1338

def authenticators_admin_sms_destroy(id, opts = {})
  authenticators_admin_sms_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for sms authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1347
1348
1349
1350
1351
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1347

def authenticators_admin_sms_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_sms_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_sms_destroy"
  end
  # resource path
  local_var_path = '/authenticators/admin/sms/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_admin_sms_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: AuthenticatorsApi#authenticators_admin_sms_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_sms_list(opts = {}) ⇒ PaginatedSMSDeviceList

Viewset for sms authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



1403
1404
1405
1406
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1403

def authenticators_admin_sms_list(opts = {})
  data, _status_code, _headers = authenticators_admin_sms_list_with_http_info(opts)
  data
end

#authenticators_admin_sms_list_with_http_info(opts = {}) ⇒ Array<(PaginatedSMSDeviceList, Integer, Hash)>

Viewset for sms authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedSMSDeviceList data, response status code and response headers



1416
1417
1418
1419
1420
1421
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
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1416

def authenticators_admin_sms_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_sms_list ...'
  end
  # resource path
  local_var_path = '/authenticators/admin/sms/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedSMSDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_sms_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: AuthenticatorsApi#authenticators_admin_sms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_sms_partial_update(id, opts = {}) ⇒ SMSDevice

Viewset for sms authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Options Hash (opts):

Returns:



1470
1471
1472
1473
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1470

def authenticators_admin_sms_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_admin_sms_partial_update_with_http_info(id, opts)
  data
end

#authenticators_admin_sms_partial_update_with_http_info(id, opts = {}) ⇒ Array<(SMSDevice, Integer, Hash)>

Viewset for sms authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SMSDevice data, response status code and response headers



1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1480

def authenticators_admin_sms_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_sms_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_sms_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/sms/{id}/'.sub('{id}', CGI.escape(id.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_sms_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_sms_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: AuthenticatorsApi#authenticators_admin_sms_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_sms_retrieve(id, opts = {}) ⇒ SMSDevice

Viewset for sms authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:



1537
1538
1539
1540
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1537

def authenticators_admin_sms_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_admin_sms_retrieve_with_http_info(id, opts)
  data
end

#authenticators_admin_sms_retrieve_with_http_info(id, opts = {}) ⇒ Array<(SMSDevice, Integer, Hash)>

Viewset for sms authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

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

    SMSDevice data, response status code and response headers



1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1546

def authenticators_admin_sms_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_sms_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_sms_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/admin/sms/{id}/'.sub('{id}', CGI.escape(id.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] || 'SMSDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_sms_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: AuthenticatorsApi#authenticators_admin_sms_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_sms_update(id, sms_device_request, opts = {}) ⇒ SMSDevice

Viewset for sms authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:



1599
1600
1601
1602
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1599

def authenticators_admin_sms_update(id, sms_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_sms_update_with_http_info(id, sms_device_request, opts)
  data
end

#authenticators_admin_sms_update_with_http_info(id, sms_device_request, opts = {}) ⇒ Array<(SMSDevice, Integer, Hash)>

Viewset for sms authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

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

    SMSDevice data, response status code and response headers



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1609

def authenticators_admin_sms_update_with_http_info(id, sms_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_sms_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_sms_update"
  end
  # verify the required parameter 'sms_device_request' is set
  if @api_client.config.client_side_validation && sms_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'sms_device_request' when calling AuthenticatorsApi.authenticators_admin_sms_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/sms/{id}/'.sub('{id}', CGI.escape(id.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(sms_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_sms_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: AuthenticatorsApi#authenticators_admin_sms_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_static_create(static_device_request, opts = {}) ⇒ StaticDevice

Viewset for static authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:



1670
1671
1672
1673
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1670

def authenticators_admin_static_create(static_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_static_create_with_http_info(static_device_request, opts)
  data
end

#authenticators_admin_static_create_with_http_info(static_device_request, opts = {}) ⇒ Array<(StaticDevice, Integer, Hash)>

Viewset for static authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:

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

    StaticDevice data, response status code and response headers



1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1679

def authenticators_admin_static_create_with_http_info(static_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_static_create ...'
  end
  # verify the required parameter 'static_device_request' is set
  if @api_client.config.client_side_validation && static_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'static_device_request' when calling AuthenticatorsApi.authenticators_admin_static_create"
  end
  # resource path
  local_var_path = '/authenticators/admin/static/'

  # 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(static_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_static_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: AuthenticatorsApi#authenticators_admin_static_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_static_destroy(id, opts = {}) ⇒ nil

Viewset for static authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

  • (nil) 


1736
1737
1738
1739
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1736

def authenticators_admin_static_destroy(id, opts = {})
  authenticators_admin_static_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for static authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1745

def authenticators_admin_static_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_static_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_static_destroy"
  end
  # resource path
  local_var_path = '/authenticators/admin/static/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_admin_static_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: AuthenticatorsApi#authenticators_admin_static_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_static_list(opts = {}) ⇒ PaginatedStaticDeviceList

Viewset for static authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



1801
1802
1803
1804
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1801

def authenticators_admin_static_list(opts = {})
  data, _status_code, _headers = authenticators_admin_static_list_with_http_info(opts)
  data
end

#authenticators_admin_static_list_with_http_info(opts = {}) ⇒ Array<(PaginatedStaticDeviceList, Integer, Hash)>

Viewset for static authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedStaticDeviceList data, response status code and response headers



1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1814

def authenticators_admin_static_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_static_list ...'
  end
  # resource path
  local_var_path = '/authenticators/admin/static/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedStaticDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_static_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: AuthenticatorsApi#authenticators_admin_static_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_static_partial_update(id, opts = {}) ⇒ StaticDevice

Viewset for static authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Options Hash (opts):

Returns:



1868
1869
1870
1871
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1868

def authenticators_admin_static_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_admin_static_partial_update_with_http_info(id, opts)
  data
end

#authenticators_admin_static_partial_update_with_http_info(id, opts = {}) ⇒ Array<(StaticDevice, Integer, Hash)>

Viewset for static authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    StaticDevice data, response status code and response headers



1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1878

def authenticators_admin_static_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_static_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_static_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/static/{id}/'.sub('{id}', CGI.escape(id.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_static_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_static_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: AuthenticatorsApi#authenticators_admin_static_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_static_retrieve(id, opts = {}) ⇒ StaticDevice

Viewset for static authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:



1935
1936
1937
1938
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1935

def authenticators_admin_static_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_admin_static_retrieve_with_http_info(id, opts)
  data
end

#authenticators_admin_static_retrieve_with_http_info(id, opts = {}) ⇒ Array<(StaticDevice, Integer, Hash)>

Viewset for static authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

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

    StaticDevice data, response status code and response headers



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1944

def authenticators_admin_static_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_static_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_static_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/admin/static/{id}/'.sub('{id}', CGI.escape(id.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] || 'StaticDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_static_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: AuthenticatorsApi#authenticators_admin_static_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_static_update(id, static_device_request, opts = {}) ⇒ StaticDevice

Viewset for static authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:



1997
1998
1999
2000
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 1997

def authenticators_admin_static_update(id, static_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_static_update_with_http_info(id, static_device_request, opts)
  data
end

#authenticators_admin_static_update_with_http_info(id, static_device_request, opts = {}) ⇒ Array<(StaticDevice, Integer, Hash)>

Viewset for static authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

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

    StaticDevice data, response status code and response headers



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2007

def authenticators_admin_static_update_with_http_info(id, static_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_static_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_static_update"
  end
  # verify the required parameter 'static_device_request' is set
  if @api_client.config.client_side_validation && static_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'static_device_request' when calling AuthenticatorsApi.authenticators_admin_static_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/static/{id}/'.sub('{id}', CGI.escape(id.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(static_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_static_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: AuthenticatorsApi#authenticators_admin_static_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_totp_create(totp_device_request, opts = {}) ⇒ TOTPDevice

Viewset for totp authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:



2068
2069
2070
2071
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2068

def authenticators_admin_totp_create(totp_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_totp_create_with_http_info(totp_device_request, opts)
  data
end

#authenticators_admin_totp_create_with_http_info(totp_device_request, opts = {}) ⇒ Array<(TOTPDevice, Integer, Hash)>

Viewset for totp authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:

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

    TOTPDevice data, response status code and response headers



2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2077

def authenticators_admin_totp_create_with_http_info(totp_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_totp_create ...'
  end
  # verify the required parameter 'totp_device_request' is set
  if @api_client.config.client_side_validation && totp_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'totp_device_request' when calling AuthenticatorsApi.authenticators_admin_totp_create"
  end
  # resource path
  local_var_path = '/authenticators/admin/totp/'

  # 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(totp_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_totp_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: AuthenticatorsApi#authenticators_admin_totp_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_totp_destroy(id, opts = {}) ⇒ nil

Viewset for totp authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

  • (nil) 


2134
2135
2136
2137
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2134

def authenticators_admin_totp_destroy(id, opts = {})
  authenticators_admin_totp_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for totp authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2143

def authenticators_admin_totp_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_totp_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_totp_destroy"
  end
  # resource path
  local_var_path = '/authenticators/admin/totp/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_admin_totp_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: AuthenticatorsApi#authenticators_admin_totp_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_totp_list(opts = {}) ⇒ PaginatedTOTPDeviceList

Viewset for totp authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



2199
2200
2201
2202
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2199

def authenticators_admin_totp_list(opts = {})
  data, _status_code, _headers = authenticators_admin_totp_list_with_http_info(opts)
  data
end

#authenticators_admin_totp_list_with_http_info(opts = {}) ⇒ Array<(PaginatedTOTPDeviceList, Integer, Hash)>

Viewset for totp authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedTOTPDeviceList data, response status code and response headers



2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2212

def authenticators_admin_totp_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_totp_list ...'
  end
  # resource path
  local_var_path = '/authenticators/admin/totp/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedTOTPDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_totp_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: AuthenticatorsApi#authenticators_admin_totp_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_totp_partial_update(id, opts = {}) ⇒ TOTPDevice

Viewset for totp authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Options Hash (opts):

Returns:



2266
2267
2268
2269
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2266

def authenticators_admin_totp_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_admin_totp_partial_update_with_http_info(id, opts)
  data
end

#authenticators_admin_totp_partial_update_with_http_info(id, opts = {}) ⇒ Array<(TOTPDevice, Integer, Hash)>

Viewset for totp authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TOTPDevice data, response status code and response headers



2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2276

def authenticators_admin_totp_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_totp_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_totp_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/totp/{id}/'.sub('{id}', CGI.escape(id.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_totp_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_totp_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: AuthenticatorsApi#authenticators_admin_totp_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_totp_retrieve(id, opts = {}) ⇒ TOTPDevice

Viewset for totp authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:



2333
2334
2335
2336
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2333

def authenticators_admin_totp_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_admin_totp_retrieve_with_http_info(id, opts)
  data
end

#authenticators_admin_totp_retrieve_with_http_info(id, opts = {}) ⇒ Array<(TOTPDevice, Integer, Hash)>

Viewset for totp authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

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

    TOTPDevice data, response status code and response headers



2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2342

def authenticators_admin_totp_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_totp_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_totp_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/admin/totp/{id}/'.sub('{id}', CGI.escape(id.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] || 'TOTPDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_totp_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: AuthenticatorsApi#authenticators_admin_totp_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_totp_update(id, totp_device_request, opts = {}) ⇒ TOTPDevice

Viewset for totp authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:



2395
2396
2397
2398
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2395

def authenticators_admin_totp_update(id, totp_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_totp_update_with_http_info(id, totp_device_request, opts)
  data
end

#authenticators_admin_totp_update_with_http_info(id, totp_device_request, opts = {}) ⇒ Array<(TOTPDevice, Integer, Hash)>

Viewset for totp authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

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

    TOTPDevice data, response status code and response headers



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2405

def authenticators_admin_totp_update_with_http_info(id, totp_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_totp_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_totp_update"
  end
  # verify the required parameter 'totp_device_request' is set
  if @api_client.config.client_side_validation && totp_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'totp_device_request' when calling AuthenticatorsApi.authenticators_admin_totp_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/totp/{id}/'.sub('{id}', CGI.escape(id.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(totp_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_totp_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: AuthenticatorsApi#authenticators_admin_totp_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_webauthn_create(web_authn_device_request, opts = {}) ⇒ WebAuthnDevice

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:



2466
2467
2468
2469
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2466

def authenticators_admin_webauthn_create(web_authn_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_webauthn_create_with_http_info(web_authn_device_request, opts)
  data
end

#authenticators_admin_webauthn_create_with_http_info(web_authn_device_request, opts = {}) ⇒ Array<(WebAuthnDevice, Integer, Hash)>

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

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

    the optional parameters

Returns:

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

    WebAuthnDevice data, response status code and response headers



2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2475

def authenticators_admin_webauthn_create_with_http_info(web_authn_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_webauthn_create ...'
  end
  # verify the required parameter 'web_authn_device_request' is set
  if @api_client.config.client_side_validation && web_authn_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'web_authn_device_request' when calling AuthenticatorsApi.authenticators_admin_webauthn_create"
  end
  # resource path
  local_var_path = '/authenticators/admin/webauthn/'

  # 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(web_authn_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_webauthn_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: AuthenticatorsApi#authenticators_admin_webauthn_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_webauthn_destroy(id, opts = {}) ⇒ nil

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

  • (nil) 


2532
2533
2534
2535
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2532

def authenticators_admin_webauthn_destroy(id, opts = {})
  authenticators_admin_webauthn_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2541

def authenticators_admin_webauthn_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_webauthn_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_webauthn_destroy"
  end
  # resource path
  local_var_path = '/authenticators/admin/webauthn/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_admin_webauthn_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: AuthenticatorsApi#authenticators_admin_webauthn_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_webauthn_list(opts = {}) ⇒ PaginatedWebAuthnDeviceList

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



2597
2598
2599
2600
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2597

def authenticators_admin_webauthn_list(opts = {})
  data, _status_code, _headers = authenticators_admin_webauthn_list_with_http_info(opts)
  data
end

#authenticators_admin_webauthn_list_with_http_info(opts = {}) ⇒ Array<(PaginatedWebAuthnDeviceList, Integer, Hash)>

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedWebAuthnDeviceList data, response status code and response headers



2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2610

def authenticators_admin_webauthn_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_webauthn_list ...'
  end
  # resource path
  local_var_path = '/authenticators/admin/webauthn/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedWebAuthnDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_webauthn_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: AuthenticatorsApi#authenticators_admin_webauthn_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_webauthn_partial_update(id, opts = {}) ⇒ WebAuthnDevice

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Options Hash (opts):

Returns:



2664
2665
2666
2667
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2664

def authenticators_admin_webauthn_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_admin_webauthn_partial_update_with_http_info(id, opts)
  data
end

#authenticators_admin_webauthn_partial_update_with_http_info(id, opts = {}) ⇒ Array<(WebAuthnDevice, Integer, Hash)>

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    WebAuthnDevice data, response status code and response headers



2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2674

def authenticators_admin_webauthn_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_webauthn_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_webauthn_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/webauthn/{id}/'.sub('{id}', CGI.escape(id.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_web_authn_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_webauthn_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: AuthenticatorsApi#authenticators_admin_webauthn_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_webauthn_retrieve(id, opts = {}) ⇒ WebAuthnDevice

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:



2731
2732
2733
2734
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2731

def authenticators_admin_webauthn_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_admin_webauthn_retrieve_with_http_info(id, opts)
  data
end

#authenticators_admin_webauthn_retrieve_with_http_info(id, opts = {}) ⇒ Array<(WebAuthnDevice, Integer, Hash)>

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

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

    WebAuthnDevice data, response status code and response headers



2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2740

def authenticators_admin_webauthn_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_webauthn_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_webauthn_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/admin/webauthn/{id}/'.sub('{id}', CGI.escape(id.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] || 'WebAuthnDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_webauthn_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: AuthenticatorsApi#authenticators_admin_webauthn_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_admin_webauthn_update(id, web_authn_device_request, opts = {}) ⇒ WebAuthnDevice

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:



2793
2794
2795
2796
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2793

def authenticators_admin_webauthn_update(id, web_authn_device_request, opts = {})
  data, _status_code, _headers = authenticators_admin_webauthn_update_with_http_info(id, web_authn_device_request, opts)
  data
end

#authenticators_admin_webauthn_update_with_http_info(id, web_authn_device_request, opts = {}) ⇒ Array<(WebAuthnDevice, Integer, Hash)>

Viewset for WebAuthn authenticator devices (for admins)

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

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

    WebAuthnDevice data, response status code and response headers



2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2803

def authenticators_admin_webauthn_update_with_http_info(id, web_authn_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_admin_webauthn_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_admin_webauthn_update"
  end
  # verify the required parameter 'web_authn_device_request' is set
  if @api_client.config.client_side_validation && web_authn_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'web_authn_device_request' when calling AuthenticatorsApi.authenticators_admin_webauthn_update"
  end
  # resource path
  local_var_path = '/authenticators/admin/webauthn/{id}/'.sub('{id}', CGI.escape(id.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(web_authn_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_admin_webauthn_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: AuthenticatorsApi#authenticators_admin_webauthn_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_all_list(opts = {}) ⇒ Array<Device>

Get all devices for current user

Parameters:

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

    the optional parameters

Returns:



2863
2864
2865
2866
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2863

def authenticators_all_list(opts = {})
  data, _status_code, _headers = authenticators_all_list_with_http_info(opts)
  data
end

#authenticators_all_list_with_http_info(opts = {}) ⇒ Array<(Array<Device>, Integer, Hash)>

Get all devices for current user

Parameters:

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

    the optional parameters

Returns:

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

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



2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2871

def authenticators_all_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_all_list ...'
  end
  # resource path
  local_var_path = '/authenticators/all/'

  # 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<Device>'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_all_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: AuthenticatorsApi#authenticators_all_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_duo_destroy(id, opts = {}) ⇒ nil

Viewset for Duo authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

  • (nil) 


2919
2920
2921
2922
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2919

def authenticators_duo_destroy(id, opts = {})
  authenticators_duo_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for Duo authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2928

def authenticators_duo_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_duo_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_duo_destroy"
  end
  # resource path
  local_var_path = '/authenticators/duo/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_duo_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: AuthenticatorsApi#authenticators_duo_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_duo_list(opts = {}) ⇒ PaginatedDuoDeviceList

Viewset for Duo authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



2984
2985
2986
2987
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2984

def authenticators_duo_list(opts = {})
  data, _status_code, _headers = authenticators_duo_list_with_http_info(opts)
  data
end

#authenticators_duo_list_with_http_info(opts = {}) ⇒ Array<(PaginatedDuoDeviceList, Integer, Hash)>

Viewset for Duo authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedDuoDeviceList data, response status code and response headers



2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 2997

def authenticators_duo_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_duo_list ...'
  end
  # resource path
  local_var_path = '/authenticators/duo/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedDuoDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_duo_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: AuthenticatorsApi#authenticators_duo_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_duo_partial_update(id, opts = {}) ⇒ DuoDevice

Viewset for Duo authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Options Hash (opts):

Returns:



3051
3052
3053
3054
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3051

def authenticators_duo_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_duo_partial_update_with_http_info(id, opts)
  data
end

#authenticators_duo_partial_update_with_http_info(id, opts = {}) ⇒ Array<(DuoDevice, Integer, Hash)>

Viewset for Duo authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DuoDevice data, response status code and response headers



3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3061

def authenticators_duo_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_duo_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_duo_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/duo/{id}/'.sub('{id}', CGI.escape(id.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_duo_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_duo_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: AuthenticatorsApi#authenticators_duo_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_duo_retrieve(id, opts = {}) ⇒ DuoDevice

Viewset for Duo authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:



3118
3119
3120
3121
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3118

def authenticators_duo_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_duo_retrieve_with_http_info(id, opts)
  data
end

#authenticators_duo_retrieve_with_http_info(id, opts = {}) ⇒ Array<(DuoDevice, Integer, Hash)>

Viewset for Duo authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

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

    DuoDevice data, response status code and response headers



3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3127

def authenticators_duo_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_duo_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_duo_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/duo/{id}/'.sub('{id}', CGI.escape(id.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] || 'DuoDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_duo_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: AuthenticatorsApi#authenticators_duo_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_duo_update(id, duo_device_request, opts = {}) ⇒ DuoDevice

Viewset for Duo authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:



3180
3181
3182
3183
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3180

def authenticators_duo_update(id, duo_device_request, opts = {})
  data, _status_code, _headers = authenticators_duo_update_with_http_info(id, duo_device_request, opts)
  data
end

#authenticators_duo_update_with_http_info(id, duo_device_request, opts = {}) ⇒ Array<(DuoDevice, Integer, Hash)>

Viewset for Duo authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

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

    DuoDevice data, response status code and response headers



3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3190

def authenticators_duo_update_with_http_info(id, duo_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_duo_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_duo_update"
  end
  # verify the required parameter 'duo_device_request' is set
  if @api_client.config.client_side_validation && duo_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'duo_device_request' when calling AuthenticatorsApi.authenticators_duo_update"
  end
  # resource path
  local_var_path = '/authenticators/duo/{id}/'.sub('{id}', CGI.escape(id.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(duo_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_duo_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: AuthenticatorsApi#authenticators_duo_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_duo_used_by_list(id, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:



3251
3252
3253
3254
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3251

def authenticators_duo_used_by_list(id, opts = {})
  data, _status_code, _headers = authenticators_duo_used_by_list_with_http_info(id, opts)
  data
end

#authenticators_duo_used_by_list_with_http_info(id, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this Duo Device.

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

    the optional parameters

Returns:

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

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



3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3260

def authenticators_duo_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_duo_used_by_list ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_duo_used_by_list"
  end
  # resource path
  local_var_path = '/authenticators/duo/{id}/used_by/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_duo_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: AuthenticatorsApi#authenticators_duo_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_email_destroy(id, opts = {}) ⇒ nil

Viewset for email authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

  • (nil) 


3312
3313
3314
3315
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3312

def authenticators_email_destroy(id, opts = {})
  authenticators_email_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for email authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3321

def authenticators_email_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_email_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_email_destroy"
  end
  # resource path
  local_var_path = '/authenticators/email/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_email_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: AuthenticatorsApi#authenticators_email_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_email_list(opts = {}) ⇒ PaginatedEmailDeviceList

Viewset for email authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



3377
3378
3379
3380
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3377

def authenticators_email_list(opts = {})
  data, _status_code, _headers = authenticators_email_list_with_http_info(opts)
  data
end

#authenticators_email_list_with_http_info(opts = {}) ⇒ Array<(PaginatedEmailDeviceList, Integer, Hash)>

Viewset for email authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedEmailDeviceList data, response status code and response headers



3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3390

def authenticators_email_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_email_list ...'
  end
  # resource path
  local_var_path = '/authenticators/email/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedEmailDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_email_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: AuthenticatorsApi#authenticators_email_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_email_partial_update(id, opts = {}) ⇒ EmailDevice

Viewset for email authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Options Hash (opts):

Returns:



3444
3445
3446
3447
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3444

def authenticators_email_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_email_partial_update_with_http_info(id, opts)
  data
end

#authenticators_email_partial_update_with_http_info(id, opts = {}) ⇒ Array<(EmailDevice, Integer, Hash)>

Viewset for email authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EmailDevice data, response status code and response headers



3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3454

def authenticators_email_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_email_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_email_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/email/{id}/'.sub('{id}', CGI.escape(id.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_email_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_email_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: AuthenticatorsApi#authenticators_email_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_email_retrieve(id, opts = {}) ⇒ EmailDevice

Viewset for email authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:



3511
3512
3513
3514
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3511

def authenticators_email_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_email_retrieve_with_http_info(id, opts)
  data
end

#authenticators_email_retrieve_with_http_info(id, opts = {}) ⇒ Array<(EmailDevice, Integer, Hash)>

Viewset for email authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

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

    EmailDevice data, response status code and response headers



3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3520

def authenticators_email_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_email_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_email_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/email/{id}/'.sub('{id}', CGI.escape(id.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] || 'EmailDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_email_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: AuthenticatorsApi#authenticators_email_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_email_update(id, email_device_request, opts = {}) ⇒ EmailDevice

Viewset for email authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:



3573
3574
3575
3576
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3573

def authenticators_email_update(id, email_device_request, opts = {})
  data, _status_code, _headers = authenticators_email_update_with_http_info(id, email_device_request, opts)
  data
end

#authenticators_email_update_with_http_info(id, email_device_request, opts = {}) ⇒ Array<(EmailDevice, Integer, Hash)>

Viewset for email authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

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

    EmailDevice data, response status code and response headers



3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3583

def authenticators_email_update_with_http_info(id, email_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_email_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_email_update"
  end
  # verify the required parameter 'email_device_request' is set
  if @api_client.config.client_side_validation && email_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_device_request' when calling AuthenticatorsApi.authenticators_email_update"
  end
  # resource path
  local_var_path = '/authenticators/email/{id}/'.sub('{id}', CGI.escape(id.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(email_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_email_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: AuthenticatorsApi#authenticators_email_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_email_used_by_list(id, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:



3644
3645
3646
3647
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3644

def authenticators_email_used_by_list(id, opts = {})
  data, _status_code, _headers = authenticators_email_used_by_list_with_http_info(id, opts)
  data
end

#authenticators_email_used_by_list_with_http_info(id, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this Email Device.

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

    the optional parameters

Returns:

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

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



3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3653

def authenticators_email_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_email_used_by_list ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_email_used_by_list"
  end
  # resource path
  local_var_path = '/authenticators/email/{id}/used_by/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_email_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: AuthenticatorsApi#authenticators_email_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_endpoint_list(opts = {}) ⇒ PaginatedGoogleEndpointDeviceList

Viewset for Endpoint authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



3709
3710
3711
3712
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3709

def authenticators_endpoint_list(opts = {})
  data, _status_code, _headers = authenticators_endpoint_list_with_http_info(opts)
  data
end

#authenticators_endpoint_list_with_http_info(opts = {}) ⇒ Array<(PaginatedGoogleEndpointDeviceList, Integer, Hash)>

Viewset for Endpoint authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3722

def authenticators_endpoint_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_endpoint_list ...'
  end
  # resource path
  local_var_path = '/authenticators/endpoint/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedGoogleEndpointDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_endpoint_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: AuthenticatorsApi#authenticators_endpoint_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_endpoint_retrieve(uuid, opts = {}) ⇒ GoogleEndpointDevice

Viewset for Endpoint authenticator devices

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:



3775
3776
3777
3778
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3775

def authenticators_endpoint_retrieve(uuid, opts = {})
  data, _status_code, _headers = authenticators_endpoint_retrieve_with_http_info(uuid, opts)
  data
end

#authenticators_endpoint_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(GoogleEndpointDevice, Integer, Hash)>

Viewset for Endpoint authenticator devices

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:

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

    GoogleEndpointDevice data, response status code and response headers



3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3784

def authenticators_endpoint_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_endpoint_retrieve ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling AuthenticatorsApi.authenticators_endpoint_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/endpoint/{uuid}/'.sub('{uuid}', CGI.escape(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] || 'GoogleEndpointDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_endpoint_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: AuthenticatorsApi#authenticators_endpoint_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_endpoint_used_by_list(uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:



3836
3837
3838
3839
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3836

def authenticators_endpoint_used_by_list(uuid, opts = {})
  data, _status_code, _headers = authenticators_endpoint_used_by_list_with_http_info(uuid, opts)
  data
end

#authenticators_endpoint_used_by_list_with_http_info(uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Endpoint Device.

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

    the optional parameters

Returns:

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

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



3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3845

def authenticators_endpoint_used_by_list_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_endpoint_used_by_list ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling AuthenticatorsApi.authenticators_endpoint_used_by_list"
  end
  # resource path
  local_var_path = '/authenticators/endpoint/{uuid}/used_by/'.sub('{uuid}', CGI.escape(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 => :"AuthenticatorsApi.authenticators_endpoint_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: AuthenticatorsApi#authenticators_endpoint_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_sms_destroy(id, opts = {}) ⇒ nil

Viewset for sms authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

  • (nil) 


3897
3898
3899
3900
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3897

def authenticators_sms_destroy(id, opts = {})
  authenticators_sms_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for sms authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3906

def authenticators_sms_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_sms_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_sms_destroy"
  end
  # resource path
  local_var_path = '/authenticators/sms/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_sms_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: AuthenticatorsApi#authenticators_sms_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_sms_list(opts = {}) ⇒ PaginatedSMSDeviceList

Viewset for sms authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



3962
3963
3964
3965
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3962

def authenticators_sms_list(opts = {})
  data, _status_code, _headers = authenticators_sms_list_with_http_info(opts)
  data
end

#authenticators_sms_list_with_http_info(opts = {}) ⇒ Array<(PaginatedSMSDeviceList, Integer, Hash)>

Viewset for sms authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedSMSDeviceList data, response status code and response headers



3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 3975

def authenticators_sms_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_sms_list ...'
  end
  # resource path
  local_var_path = '/authenticators/sms/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedSMSDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_sms_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: AuthenticatorsApi#authenticators_sms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_sms_partial_update(id, opts = {}) ⇒ SMSDevice

Viewset for sms authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Options Hash (opts):

Returns:



4029
4030
4031
4032
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4029

def authenticators_sms_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_sms_partial_update_with_http_info(id, opts)
  data
end

#authenticators_sms_partial_update_with_http_info(id, opts = {}) ⇒ Array<(SMSDevice, Integer, Hash)>

Viewset for sms authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SMSDevice data, response status code and response headers



4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4039

def authenticators_sms_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_sms_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_sms_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/sms/{id}/'.sub('{id}', CGI.escape(id.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_sms_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_sms_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: AuthenticatorsApi#authenticators_sms_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_sms_retrieve(id, opts = {}) ⇒ SMSDevice

Viewset for sms authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:



4096
4097
4098
4099
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4096

def authenticators_sms_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_sms_retrieve_with_http_info(id, opts)
  data
end

#authenticators_sms_retrieve_with_http_info(id, opts = {}) ⇒ Array<(SMSDevice, Integer, Hash)>

Viewset for sms authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

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

    SMSDevice data, response status code and response headers



4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4105

def authenticators_sms_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_sms_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_sms_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/sms/{id}/'.sub('{id}', CGI.escape(id.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] || 'SMSDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_sms_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: AuthenticatorsApi#authenticators_sms_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_sms_update(id, sms_device_request, opts = {}) ⇒ SMSDevice

Viewset for sms authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:



4158
4159
4160
4161
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4158

def authenticators_sms_update(id, sms_device_request, opts = {})
  data, _status_code, _headers = authenticators_sms_update_with_http_info(id, sms_device_request, opts)
  data
end

#authenticators_sms_update_with_http_info(id, sms_device_request, opts = {}) ⇒ Array<(SMSDevice, Integer, Hash)>

Viewset for sms authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

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

    SMSDevice data, response status code and response headers



4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4168

def authenticators_sms_update_with_http_info(id, sms_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_sms_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_sms_update"
  end
  # verify the required parameter 'sms_device_request' is set
  if @api_client.config.client_side_validation && sms_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'sms_device_request' when calling AuthenticatorsApi.authenticators_sms_update"
  end
  # resource path
  local_var_path = '/authenticators/sms/{id}/'.sub('{id}', CGI.escape(id.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(sms_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_sms_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: AuthenticatorsApi#authenticators_sms_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_sms_used_by_list(id, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:



4229
4230
4231
4232
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4229

def authenticators_sms_used_by_list(id, opts = {})
  data, _status_code, _headers = authenticators_sms_used_by_list_with_http_info(id, opts)
  data
end

#authenticators_sms_used_by_list_with_http_info(id, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this SMS Device.

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

    the optional parameters

Returns:

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

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



4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4238

def authenticators_sms_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_sms_used_by_list ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_sms_used_by_list"
  end
  # resource path
  local_var_path = '/authenticators/sms/{id}/used_by/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_sms_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: AuthenticatorsApi#authenticators_sms_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_static_destroy(id, opts = {}) ⇒ nil

Viewset for static authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

  • (nil) 


4290
4291
4292
4293
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4290

def authenticators_static_destroy(id, opts = {})
  authenticators_static_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for static authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4299

def authenticators_static_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_static_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_static_destroy"
  end
  # resource path
  local_var_path = '/authenticators/static/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_static_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: AuthenticatorsApi#authenticators_static_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_static_list(opts = {}) ⇒ PaginatedStaticDeviceList

Viewset for static authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



4355
4356
4357
4358
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4355

def authenticators_static_list(opts = {})
  data, _status_code, _headers = authenticators_static_list_with_http_info(opts)
  data
end

#authenticators_static_list_with_http_info(opts = {}) ⇒ Array<(PaginatedStaticDeviceList, Integer, Hash)>

Viewset for static authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedStaticDeviceList data, response status code and response headers



4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4368

def authenticators_static_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_static_list ...'
  end
  # resource path
  local_var_path = '/authenticators/static/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedStaticDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_static_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: AuthenticatorsApi#authenticators_static_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_static_partial_update(id, opts = {}) ⇒ StaticDevice

Viewset for static authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Options Hash (opts):

Returns:



4422
4423
4424
4425
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4422

def authenticators_static_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_static_partial_update_with_http_info(id, opts)
  data
end

#authenticators_static_partial_update_with_http_info(id, opts = {}) ⇒ Array<(StaticDevice, Integer, Hash)>

Viewset for static authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    StaticDevice data, response status code and response headers



4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4432

def authenticators_static_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_static_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_static_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/static/{id}/'.sub('{id}', CGI.escape(id.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_static_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_static_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: AuthenticatorsApi#authenticators_static_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_static_retrieve(id, opts = {}) ⇒ StaticDevice

Viewset for static authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:



4489
4490
4491
4492
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4489

def authenticators_static_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_static_retrieve_with_http_info(id, opts)
  data
end

#authenticators_static_retrieve_with_http_info(id, opts = {}) ⇒ Array<(StaticDevice, Integer, Hash)>

Viewset for static authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

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

    StaticDevice data, response status code and response headers



4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4498

def authenticators_static_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_static_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_static_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/static/{id}/'.sub('{id}', CGI.escape(id.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] || 'StaticDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_static_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: AuthenticatorsApi#authenticators_static_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_static_update(id, static_device_request, opts = {}) ⇒ StaticDevice

Viewset for static authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:



4551
4552
4553
4554
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4551

def authenticators_static_update(id, static_device_request, opts = {})
  data, _status_code, _headers = authenticators_static_update_with_http_info(id, static_device_request, opts)
  data
end

#authenticators_static_update_with_http_info(id, static_device_request, opts = {}) ⇒ Array<(StaticDevice, Integer, Hash)>

Viewset for static authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

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

    StaticDevice data, response status code and response headers



4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4561

def authenticators_static_update_with_http_info(id, static_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_static_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_static_update"
  end
  # verify the required parameter 'static_device_request' is set
  if @api_client.config.client_side_validation && static_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'static_device_request' when calling AuthenticatorsApi.authenticators_static_update"
  end
  # resource path
  local_var_path = '/authenticators/static/{id}/'.sub('{id}', CGI.escape(id.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(static_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_static_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: AuthenticatorsApi#authenticators_static_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_static_used_by_list(id, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:



4622
4623
4624
4625
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4622

def authenticators_static_used_by_list(id, opts = {})
  data, _status_code, _headers = authenticators_static_used_by_list_with_http_info(id, opts)
  data
end

#authenticators_static_used_by_list_with_http_info(id, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this Static Device.

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

    the optional parameters

Returns:

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

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



4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4631

def authenticators_static_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_static_used_by_list ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_static_used_by_list"
  end
  # resource path
  local_var_path = '/authenticators/static/{id}/used_by/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_static_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: AuthenticatorsApi#authenticators_static_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_totp_destroy(id, opts = {}) ⇒ nil

Viewset for totp authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

  • (nil) 


4683
4684
4685
4686
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4683

def authenticators_totp_destroy(id, opts = {})
  authenticators_totp_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for totp authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4692

def authenticators_totp_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_totp_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_totp_destroy"
  end
  # resource path
  local_var_path = '/authenticators/totp/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_totp_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: AuthenticatorsApi#authenticators_totp_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_totp_list(opts = {}) ⇒ PaginatedTOTPDeviceList

Viewset for totp authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



4748
4749
4750
4751
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4748

def authenticators_totp_list(opts = {})
  data, _status_code, _headers = authenticators_totp_list_with_http_info(opts)
  data
end

#authenticators_totp_list_with_http_info(opts = {}) ⇒ Array<(PaginatedTOTPDeviceList, Integer, Hash)>

Viewset for totp authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedTOTPDeviceList data, response status code and response headers



4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4761

def authenticators_totp_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_totp_list ...'
  end
  # resource path
  local_var_path = '/authenticators/totp/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedTOTPDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_totp_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: AuthenticatorsApi#authenticators_totp_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_totp_partial_update(id, opts = {}) ⇒ TOTPDevice

Viewset for totp authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Options Hash (opts):

Returns:



4815
4816
4817
4818
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4815

def authenticators_totp_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_totp_partial_update_with_http_info(id, opts)
  data
end

#authenticators_totp_partial_update_with_http_info(id, opts = {}) ⇒ Array<(TOTPDevice, Integer, Hash)>

Viewset for totp authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TOTPDevice data, response status code and response headers



4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4825

def authenticators_totp_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_totp_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_totp_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/totp/{id}/'.sub('{id}', CGI.escape(id.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_totp_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_totp_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: AuthenticatorsApi#authenticators_totp_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_totp_retrieve(id, opts = {}) ⇒ TOTPDevice

Viewset for totp authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:



4882
4883
4884
4885
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4882

def authenticators_totp_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_totp_retrieve_with_http_info(id, opts)
  data
end

#authenticators_totp_retrieve_with_http_info(id, opts = {}) ⇒ Array<(TOTPDevice, Integer, Hash)>

Viewset for totp authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

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

    TOTPDevice data, response status code and response headers



4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4891

def authenticators_totp_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_totp_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_totp_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/totp/{id}/'.sub('{id}', CGI.escape(id.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] || 'TOTPDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_totp_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: AuthenticatorsApi#authenticators_totp_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_totp_update(id, totp_device_request, opts = {}) ⇒ TOTPDevice

Viewset for totp authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:



4944
4945
4946
4947
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4944

def authenticators_totp_update(id, totp_device_request, opts = {})
  data, _status_code, _headers = authenticators_totp_update_with_http_info(id, totp_device_request, opts)
  data
end

#authenticators_totp_update_with_http_info(id, totp_device_request, opts = {}) ⇒ Array<(TOTPDevice, Integer, Hash)>

Viewset for totp authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

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

    TOTPDevice data, response status code and response headers



4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 4954

def authenticators_totp_update_with_http_info(id, totp_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_totp_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_totp_update"
  end
  # verify the required parameter 'totp_device_request' is set
  if @api_client.config.client_side_validation && totp_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'totp_device_request' when calling AuthenticatorsApi.authenticators_totp_update"
  end
  # resource path
  local_var_path = '/authenticators/totp/{id}/'.sub('{id}', CGI.escape(id.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(totp_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_totp_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: AuthenticatorsApi#authenticators_totp_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_totp_used_by_list(id, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:



5015
5016
5017
5018
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5015

def authenticators_totp_used_by_list(id, opts = {})
  data, _status_code, _headers = authenticators_totp_used_by_list_with_http_info(id, opts)
  data
end

#authenticators_totp_used_by_list_with_http_info(id, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this TOTP Device.

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

    the optional parameters

Returns:

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

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



5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5024

def authenticators_totp_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_totp_used_by_list ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_totp_used_by_list"
  end
  # resource path
  local_var_path = '/authenticators/totp/{id}/used_by/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_totp_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: AuthenticatorsApi#authenticators_totp_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_webauthn_destroy(id, opts = {}) ⇒ nil

Viewset for WebAuthn authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

  • (nil) 


5076
5077
5078
5079
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5076

def authenticators_webauthn_destroy(id, opts = {})
  authenticators_webauthn_destroy_with_http_info(id, opts)
  nil
end

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

Viewset for WebAuthn authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5085

def authenticators_webauthn_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_webauthn_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_webauthn_destroy"
  end
  # resource path
  local_var_path = '/authenticators/webauthn/{id}/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_webauthn_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: AuthenticatorsApi#authenticators_webauthn_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_webauthn_list(opts = {}) ⇒ PaginatedWebAuthnDeviceList

Viewset for WebAuthn authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



5141
5142
5143
5144
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5141

def authenticators_webauthn_list(opts = {})
  data, _status_code, _headers = authenticators_webauthn_list_with_http_info(opts)
  data
end

#authenticators_webauthn_list_with_http_info(opts = {}) ⇒ Array<(PaginatedWebAuthnDeviceList, Integer, Hash)>

Viewset for WebAuthn authenticator devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    PaginatedWebAuthnDeviceList data, response status code and response headers



5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5154

def authenticators_webauthn_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_webauthn_list ...'
  end
  # resource path
  local_var_path = '/authenticators/webauthn/'

  # query parameters
  query_params = opts[:query_params] || {}
  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?

  # 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] || 'PaginatedWebAuthnDeviceList'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_webauthn_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: AuthenticatorsApi#authenticators_webauthn_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_webauthn_partial_update(id, opts = {}) ⇒ WebAuthnDevice

Viewset for WebAuthn authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Options Hash (opts):

Returns:



5208
5209
5210
5211
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5208

def authenticators_webauthn_partial_update(id, opts = {})
  data, _status_code, _headers = authenticators_webauthn_partial_update_with_http_info(id, opts)
  data
end

#authenticators_webauthn_partial_update_with_http_info(id, opts = {}) ⇒ Array<(WebAuthnDevice, Integer, Hash)>

Viewset for WebAuthn authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    WebAuthnDevice data, response status code and response headers



5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5218

def authenticators_webauthn_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_webauthn_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_webauthn_partial_update"
  end
  # resource path
  local_var_path = '/authenticators/webauthn/{id}/'.sub('{id}', CGI.escape(id.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_web_authn_device_request'])

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_webauthn_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: AuthenticatorsApi#authenticators_webauthn_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_webauthn_retrieve(id, opts = {}) ⇒ WebAuthnDevice

Viewset for WebAuthn authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:



5275
5276
5277
5278
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5275

def authenticators_webauthn_retrieve(id, opts = {})
  data, _status_code, _headers = authenticators_webauthn_retrieve_with_http_info(id, opts)
  data
end

#authenticators_webauthn_retrieve_with_http_info(id, opts = {}) ⇒ Array<(WebAuthnDevice, Integer, Hash)>

Viewset for WebAuthn authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

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

    WebAuthnDevice data, response status code and response headers



5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5284

def authenticators_webauthn_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_webauthn_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_webauthn_retrieve"
  end
  # resource path
  local_var_path = '/authenticators/webauthn/{id}/'.sub('{id}', CGI.escape(id.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] || 'WebAuthnDevice'

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_webauthn_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: AuthenticatorsApi#authenticators_webauthn_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_webauthn_update(id, web_authn_device_request, opts = {}) ⇒ WebAuthnDevice

Viewset for WebAuthn authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:



5337
5338
5339
5340
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5337

def authenticators_webauthn_update(id, web_authn_device_request, opts = {})
  data, _status_code, _headers = authenticators_webauthn_update_with_http_info(id, web_authn_device_request, opts)
  data
end

#authenticators_webauthn_update_with_http_info(id, web_authn_device_request, opts = {}) ⇒ Array<(WebAuthnDevice, Integer, Hash)>

Viewset for WebAuthn authenticator devices

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

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

    WebAuthnDevice data, response status code and response headers



5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5347

def authenticators_webauthn_update_with_http_info(id, web_authn_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_webauthn_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_webauthn_update"
  end
  # verify the required parameter 'web_authn_device_request' is set
  if @api_client.config.client_side_validation && web_authn_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'web_authn_device_request' when calling AuthenticatorsApi.authenticators_webauthn_update"
  end
  # resource path
  local_var_path = '/authenticators/webauthn/{id}/'.sub('{id}', CGI.escape(id.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(web_authn_device_request)

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

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

  new_options = opts.merge(
    :operation => :"AuthenticatorsApi.authenticators_webauthn_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: AuthenticatorsApi#authenticators_webauthn_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authenticators_webauthn_used_by_list(id, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:



5408
5409
5410
5411
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5408

def authenticators_webauthn_used_by_list(id, opts = {})
  data, _status_code, _headers = authenticators_webauthn_used_by_list_with_http_info(id, opts)
  data
end

#authenticators_webauthn_used_by_list_with_http_info(id, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this WebAuthn Device.

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

    the optional parameters

Returns:

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

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



5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
 
# File 'lib/authentik/api/api/authenticators_api.rb', line 5417

def authenticators_webauthn_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.authenticators_webauthn_used_by_list ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticatorsApi.authenticators_webauthn_used_by_list"
  end
  # resource path
  local_var_path = '/authenticators/webauthn/{id}/used_by/'.sub('{id}', CGI.escape(id.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 => :"AuthenticatorsApi.authenticators_webauthn_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: AuthenticatorsApi#authenticators_webauthn_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end