Class: Authentik::Api::CoreApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CoreApi

Returns a new instance of CoreApi.



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

def api_client
  @api_client
end

Instance Method Details

#core_application_entitlements_create(application_entitlement_request, opts = {}) ⇒ ApplicationEntitlement

ApplicationEntitlement Viewset

Parameters:

Returns:



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

def core_application_entitlements_create(application_entitlement_request, opts = {})
  data, _status_code, _headers = core_application_entitlements_create_with_http_info(application_entitlement_request, opts)
  data
end

#core_application_entitlements_create_with_http_info(application_entitlement_request, opts = {}) ⇒ Array<(ApplicationEntitlement, Integer, Hash)>

ApplicationEntitlement Viewset

Parameters:

Returns:

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

    ApplicationEntitlement data, response status code and response headers



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

def core_application_entitlements_create_with_http_info(application_entitlement_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_application_entitlements_create ...'
  end
  # verify the required parameter 'application_entitlement_request' is set
  if @api_client.config.client_side_validation && application_entitlement_request.nil?
    fail ArgumentError, "Missing the required parameter 'application_entitlement_request' when calling CoreApi.core_application_entitlements_create"
  end
  # resource path
  local_var_path = '/core/application_entitlements/'

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

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

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

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

#core_application_entitlements_destroy(pbm_uuid, opts = {}) ⇒ nil

ApplicationEntitlement Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Returns:

  • (nil) 


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

def core_application_entitlements_destroy(pbm_uuid, opts = {})
  core_application_entitlements_destroy_with_http_info(pbm_uuid, opts)
  nil
end

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

ApplicationEntitlement Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#core_application_entitlements_list(opts = {}) ⇒ PaginatedApplicationEntitlementList

ApplicationEntitlement Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :app (String)
  • :name (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :pbm_uuid (String)
  • :search (String) —

    A search term.

Returns:



153
154
155
156
 
# File 'lib/authentik/api/api/core_api.rb', line 153

def core_application_entitlements_list(opts = {})
  data, _status_code, _headers = core_application_entitlements_list_with_http_info(opts)
  data
end

#core_application_entitlements_list_with_http_info(opts = {}) ⇒ Array<(PaginatedApplicationEntitlementList, Integer, Hash)>

ApplicationEntitlement Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :app (String)
  • :name (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :pbm_uuid (String)
  • :search (String) —

    A search term.

Returns:



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/authentik/api/api/core_api.rb', line 168

def core_application_entitlements_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_application_entitlements_list ...'
  end
  # resource path
  local_var_path = '/core/application_entitlements/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app'] = opts[:'app'] if !opts[:'app'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'pbm_uuid'] = opts[:'pbm_uuid'] if !opts[:'pbm_uuid'].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] || 'PaginatedApplicationEntitlementList'

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

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

#core_application_entitlements_partial_update(pbm_uuid, opts = {}) ⇒ ApplicationEntitlement

ApplicationEntitlement Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Options Hash (opts):

Returns:



224
225
226
227
 
# File 'lib/authentik/api/api/core_api.rb', line 224

def core_application_entitlements_partial_update(pbm_uuid, opts = {})
  data, _status_code, _headers = core_application_entitlements_partial_update_with_http_info(pbm_uuid, opts)
  data
end

#core_application_entitlements_partial_update_with_http_info(pbm_uuid, opts = {}) ⇒ Array<(ApplicationEntitlement, Integer, Hash)>

ApplicationEntitlement Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ApplicationEntitlement data, response status code and response headers



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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/authentik/api/api/core_api.rb', line 234

def core_application_entitlements_partial_update_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_application_entitlements_partial_update ...'
  end
  # verify the required parameter 'pbm_uuid' is set
  if @api_client.config.client_side_validation && pbm_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'pbm_uuid' when calling CoreApi.core_application_entitlements_partial_update"
  end
  # resource path
  local_var_path = '/core/application_entitlements/{pbm_uuid}/'.sub('{pbm_uuid}', CGI.escape(pbm_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_application_entitlement_request'])

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

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

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

#core_application_entitlements_retrieve(pbm_uuid, opts = {}) ⇒ ApplicationEntitlement

ApplicationEntitlement Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Returns:



291
292
293
294
 
# File 'lib/authentik/api/api/core_api.rb', line 291

def core_application_entitlements_retrieve(pbm_uuid, opts = {})
  data, _status_code, _headers = core_application_entitlements_retrieve_with_http_info(pbm_uuid, opts)
  data
end

#core_application_entitlements_retrieve_with_http_info(pbm_uuid, opts = {}) ⇒ Array<(ApplicationEntitlement, Integer, Hash)>

ApplicationEntitlement Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Returns:

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

    ApplicationEntitlement data, response status code and response headers



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
338
339
340
341
342
343
344
345
346
 
# File 'lib/authentik/api/api/core_api.rb', line 300

def core_application_entitlements_retrieve_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_application_entitlements_retrieve ...'
  end
  # verify the required parameter 'pbm_uuid' is set
  if @api_client.config.client_side_validation && pbm_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'pbm_uuid' when calling CoreApi.core_application_entitlements_retrieve"
  end
  # resource path
  local_var_path = '/core/application_entitlements/{pbm_uuid}/'.sub('{pbm_uuid}', CGI.escape(pbm_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] || 'ApplicationEntitlement'

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

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

#core_application_entitlements_update(pbm_uuid, application_entitlement_request, opts = {}) ⇒ ApplicationEntitlement

ApplicationEntitlement Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Returns:



353
354
355
356
 
# File 'lib/authentik/api/api/core_api.rb', line 353

def core_application_entitlements_update(pbm_uuid, application_entitlement_request, opts = {})
  data, _status_code, _headers = core_application_entitlements_update_with_http_info(pbm_uuid, application_entitlement_request, opts)
  data
end

#core_application_entitlements_update_with_http_info(pbm_uuid, application_entitlement_request, opts = {}) ⇒ Array<(ApplicationEntitlement, Integer, Hash)>

ApplicationEntitlement Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Returns:

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

    ApplicationEntitlement data, response status code and response headers



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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/authentik/api/api/core_api.rb', line 363

def core_application_entitlements_update_with_http_info(pbm_uuid, application_entitlement_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_application_entitlements_update ...'
  end
  # verify the required parameter 'pbm_uuid' is set
  if @api_client.config.client_side_validation && pbm_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'pbm_uuid' when calling CoreApi.core_application_entitlements_update"
  end
  # verify the required parameter 'application_entitlement_request' is set
  if @api_client.config.client_side_validation && application_entitlement_request.nil?
    fail ArgumentError, "Missing the required parameter 'application_entitlement_request' when calling CoreApi.core_application_entitlements_update"
  end
  # resource path
  local_var_path = '/core/application_entitlements/{pbm_uuid}/'.sub('{pbm_uuid}', CGI.escape(pbm_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(application_entitlement_request)

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

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

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

#core_application_entitlements_used_by_list(pbm_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Returns:



424
425
426
427
 
# File 'lib/authentik/api/api/core_api.rb', line 424

def core_application_entitlements_used_by_list(pbm_uuid, opts = {})
  data, _status_code, _headers = core_application_entitlements_used_by_list_with_http_info(pbm_uuid, opts)
  data
end

#core_application_entitlements_used_by_list_with_http_info(pbm_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Application Entitlement.

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

    the optional parameters

Returns:

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

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



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
471
472
473
474
475
476
477
478
479
 
# File 'lib/authentik/api/api/core_api.rb', line 433

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

#core_applications_check_access_retrieve(slug, opts = {}) ⇒ PolicyTestResult

Check access to a single application by slug

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :for_user (Integer)

Returns:



486
487
488
489
 
# File 'lib/authentik/api/api/core_api.rb', line 486

def core_applications_check_access_retrieve(slug, opts = {})
  data, _status_code, _headers = core_applications_check_access_retrieve_with_http_info(slug, opts)
  data
end

#core_applications_check_access_retrieve_with_http_info(slug, opts = {}) ⇒ Array<(PolicyTestResult, Integer, Hash)>

Check access to a single application by slug

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :for_user (Integer)

Returns:

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

    PolicyTestResult data, response status code and response headers



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
537
538
539
540
541
542
543
 
# File 'lib/authentik/api/api/core_api.rb', line 496

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'for_user'] = opts[:'for_user'] if !opts[:'for_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] || 'PolicyTestResult'

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

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

#core_applications_create(application_request, opts = {}) ⇒ Application

Application Viewset

Parameters:

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

    the optional parameters

Returns:



549
550
551
552
 
# File 'lib/authentik/api/api/core_api.rb', line 549

def core_applications_create(application_request, opts = {})
  data, _status_code, _headers = core_applications_create_with_http_info(application_request, opts)
  data
end

#core_applications_create_with_http_info(application_request, opts = {}) ⇒ Array<(Application, Integer, Hash)>

Application Viewset

Parameters:

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

    the optional parameters

Returns:

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

    Application data, response status code and response headers



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
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/authentik/api/api/core_api.rb', line 558

def core_applications_create_with_http_info(application_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_applications_create ...'
  end
  # verify the required parameter 'application_request' is set
  if @api_client.config.client_side_validation && application_request.nil?
    fail ArgumentError, "Missing the required parameter 'application_request' when calling CoreApi.core_applications_create"
  end
  # resource path
  local_var_path = '/core/applications/'

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

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

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

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

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

Application Viewset

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


615
616
617
618
 
# File 'lib/authentik/api/api/core_api.rb', line 615

def core_applications_destroy(slug, opts = {})
  core_applications_destroy_with_http_info(slug, opts)
  nil
end

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

Application Viewset

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
668
669
670
 
# File 'lib/authentik/api/api/core_api.rb', line 624

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#core_applications_list(opts = {}) ⇒ PaginatedApplicationList

Custom list method that checks Policy based access instead of guardian

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :for_user (Integer)
  • :group (String)
  • :meta_description (String)
  • :meta_launch_url (String)
  • :meta_publisher (String)
  • :name (String)
  • :only_with_launch_url (Boolean)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :slug (String)
  • :superuser_full_list (Boolean)

Returns:



688
689
690
691
 
# File 'lib/authentik/api/api/core_api.rb', line 688

def core_applications_list(opts = {})
  data, _status_code, _headers = core_applications_list_with_http_info(opts)
  data
end

#core_applications_list_with_http_info(opts = {}) ⇒ Array<(PaginatedApplicationList, Integer, Hash)>

Custom list method that checks Policy based access instead of guardian

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :for_user (Integer)
  • :group (String)
  • :meta_description (String)
  • :meta_launch_url (String)
  • :meta_publisher (String)
  • :name (String)
  • :only_with_launch_url (Boolean)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :slug (String)
  • :superuser_full_list (Boolean)

Returns:

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

    PaginatedApplicationList data, response status code and response headers



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
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/authentik/api/api/core_api.rb', line 709

def core_applications_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_applications_list ...'
  end
  # resource path
  local_var_path = '/core/applications/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'for_user'] = opts[:'for_user'] if !opts[:'for_user'].nil?
  query_params[:'group'] = opts[:'group'] if !opts[:'group'].nil?
  query_params[:'meta_description'] = opts[:'meta_description'] if !opts[:'meta_description'].nil?
  query_params[:'meta_launch_url'] = opts[:'meta_launch_url'] if !opts[:'meta_launch_url'].nil?
  query_params[:'meta_publisher'] = opts[:'meta_publisher'] if !opts[:'meta_publisher'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'only_with_launch_url'] = opts[:'only_with_launch_url'] if !opts[:'only_with_launch_url'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'slug'] = opts[:'slug'] if !opts[:'slug'].nil?
  query_params[:'superuser_full_list'] = opts[:'superuser_full_list'] if !opts[:'superuser_full_list'].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] || 'PaginatedApplicationList'

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

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

#core_applications_partial_update(slug, opts = {}) ⇒ Application

Application Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



771
772
773
774
 
# File 'lib/authentik/api/api/core_api.rb', line 771

def core_applications_partial_update(slug, opts = {})
  data, _status_code, _headers = core_applications_partial_update_with_http_info(slug, opts)
  data
end

#core_applications_partial_update_with_http_info(slug, opts = {}) ⇒ Array<(Application, Integer, Hash)>

Application Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Application data, response status code and response headers



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/authentik/api/api/core_api.rb', line 781

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

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

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

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

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

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

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

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

#core_applications_retrieve(slug, opts = {}) ⇒ Application

Application Viewset

Parameters:

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

    the optional parameters

Returns:



838
839
840
841
 
# File 'lib/authentik/api/api/core_api.rb', line 838

def core_applications_retrieve(slug, opts = {})
  data, _status_code, _headers = core_applications_retrieve_with_http_info(slug, opts)
  data
end

#core_applications_retrieve_with_http_info(slug, opts = {}) ⇒ Array<(Application, Integer, Hash)>

Application Viewset

Parameters:

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

    the optional parameters

Returns:

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

    Application data, response status code and response headers



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/authentik/api/api/core_api.rb', line 847

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

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

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

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

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

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

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

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

#core_applications_update(slug, application_request, opts = {}) ⇒ Application

Application Viewset

Parameters:

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

    the optional parameters

Returns:



900
901
902
903
 
# File 'lib/authentik/api/api/core_api.rb', line 900

def core_applications_update(slug, application_request, opts = {})
  data, _status_code, _headers = core_applications_update_with_http_info(slug, application_request, opts)
  data
end

#core_applications_update_with_http_info(slug, application_request, opts = {}) ⇒ Array<(Application, Integer, Hash)>

Application Viewset

Parameters:

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

    the optional parameters

Returns:

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

    Application data, response status code and response headers



910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
 
# File 'lib/authentik/api/api/core_api.rb', line 910

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

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

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

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

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

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

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

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

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

Get a list of all objects that use this object

Parameters:

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

    the optional parameters

Returns:



971
972
973
974
 
# File 'lib/authentik/api/api/core_api.rb', line 971

def core_applications_used_by_list(slug, opts = {})
  data, _status_code, _headers = core_applications_used_by_list_with_http_info(slug, opts)
  data
end

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

Get a list of all objects that use this object

Parameters:

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

    the optional parameters

Returns:

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

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



980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/authentik/api/api/core_api.rb', line 980

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

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

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

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

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

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

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

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

#core_authenticated_sessions_bulk_delete_destroy(user_pks, opts = {}) ⇒ BulkDeleteSessionResponse

Bulk revoke all sessions for multiple users

Parameters:

  • user_pks (Array<Integer>) —

    List of user IDs to revoke all sessions for

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

    the optional parameters

Returns:



1032
1033
1034
1035
 
# File 'lib/authentik/api/api/core_api.rb', line 1032

def core_authenticated_sessions_bulk_delete_destroy(user_pks, opts = {})
  data, _status_code, _headers = core_authenticated_sessions_bulk_delete_destroy_with_http_info(user_pks, opts)
  data
end

#core_authenticated_sessions_bulk_delete_destroy_with_http_info(user_pks, opts = {}) ⇒ Array<(BulkDeleteSessionResponse, Integer, Hash)>

Bulk revoke all sessions for multiple users

Parameters:

  • user_pks (Array<Integer>) —

    List of user IDs to revoke all sessions for

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

    the optional parameters

Returns:

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

    BulkDeleteSessionResponse data, response status code and response headers



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
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/authentik/api/api/core_api.rb', line 1041

def core_authenticated_sessions_bulk_delete_destroy_with_http_info(user_pks, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_authenticated_sessions_bulk_delete_destroy ...'
  end
  # verify the required parameter 'user_pks' is set
  if @api_client.config.client_side_validation && user_pks.nil?
    fail ArgumentError, "Missing the required parameter 'user_pks' when calling CoreApi.core_authenticated_sessions_bulk_delete_destroy"
  end
  # resource path
  local_var_path = '/core/authenticated_sessions/bulk_delete/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_pks'] = @api_client.build_collection_param(user_pks, :multi)

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

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

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

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

AuthenticatedSession Viewset

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1094
1095
1096
1097
 
# File 'lib/authentik/api/api/core_api.rb', line 1094

def core_authenticated_sessions_destroy(uuid, opts = {})
  core_authenticated_sessions_destroy_with_http_info(uuid, opts)
  nil
end

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

AuthenticatedSession Viewset

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/authentik/api/api/core_api.rb', line 1103

def core_authenticated_sessions_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_authenticated_sessions_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 CoreApi.core_authenticated_sessions_destroy"
  end
  # resource path
  local_var_path = '/core/authenticated_sessions/{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 => :"CoreApi.core_authenticated_sessions_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: CoreApi#core_authenticated_sessions_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#core_authenticated_sessions_list(opts = {}) ⇒ PaginatedAuthenticatedSessionList

AuthenticatedSession Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :session__last_ip (String)
  • :session__last_user_agent (String)
  • :user__username (String)

Returns:



1161
1162
1163
1164
 
# File 'lib/authentik/api/api/core_api.rb', line 1161

def core_authenticated_sessions_list(opts = {})
  data, _status_code, _headers = core_authenticated_sessions_list_with_http_info(opts)
  data
end

#core_authenticated_sessions_list_with_http_info(opts = {}) ⇒ Array<(PaginatedAuthenticatedSessionList, Integer, Hash)>

AuthenticatedSession Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :session__last_ip (String)
  • :session__last_user_agent (String)
  • :user__username (String)

Returns:



1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'lib/authentik/api/api/core_api.rb', line 1176

def core_authenticated_sessions_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_authenticated_sessions_list ...'
  end
  # resource path
  local_var_path = '/core/authenticated_sessions/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'session__last_ip'] = opts[:'session__last_ip'] if !opts[:'session__last_ip'].nil?
  query_params[:'session__last_user_agent'] = opts[:'session__last_user_agent'] if !opts[:'session__last_user_agent'].nil?
  query_params[:'user__username'] = opts[:'user__username'] if !opts[:'user__username'].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] || 'PaginatedAuthenticatedSessionList'

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

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

#core_authenticated_sessions_retrieve(uuid, opts = {}) ⇒ AuthenticatedSession

AuthenticatedSession Viewset

Parameters:

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

    the optional parameters

Returns:



1231
1232
1233
1234
 
# File 'lib/authentik/api/api/core_api.rb', line 1231

def core_authenticated_sessions_retrieve(uuid, opts = {})
  data, _status_code, _headers = core_authenticated_sessions_retrieve_with_http_info(uuid, opts)
  data
end

#core_authenticated_sessions_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(AuthenticatedSession, Integer, Hash)>

AuthenticatedSession Viewset

Parameters:

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

    the optional parameters

Returns:

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

    AuthenticatedSession data, response status code and response headers



1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/authentik/api/api/core_api.rb', line 1240

def core_authenticated_sessions_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_authenticated_sessions_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 CoreApi.core_authenticated_sessions_retrieve"
  end
  # resource path
  local_var_path = '/core/authenticated_sessions/{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] || 'AuthenticatedSession'

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

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

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

Get a list of all objects that use this object

Parameters:

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

    the optional parameters

Returns:



1292
1293
1294
1295
 
# File 'lib/authentik/api/api/core_api.rb', line 1292

def core_authenticated_sessions_used_by_list(uuid, opts = {})
  data, _status_code, _headers = core_authenticated_sessions_used_by_list_with_http_info(uuid, opts)
  data
end

#core_authenticated_sessions_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)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

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



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/authentik/api/api/core_api.rb', line 1301

def core_authenticated_sessions_used_by_list_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_authenticated_sessions_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 CoreApi.core_authenticated_sessions_used_by_list"
  end
  # resource path
  local_var_path = '/core/authenticated_sessions/{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 => :"CoreApi.core_authenticated_sessions_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: CoreApi#core_authenticated_sessions_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#core_brands_create(brand_request, opts = {}) ⇒ Brand

Brand Viewset

Parameters:

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

    the optional parameters

Returns:



1353
1354
1355
1356
 
# File 'lib/authentik/api/api/core_api.rb', line 1353

def core_brands_create(brand_request, opts = {})
  data, _status_code, _headers = core_brands_create_with_http_info(brand_request, opts)
  data
end

#core_brands_create_with_http_info(brand_request, opts = {}) ⇒ Array<(Brand, Integer, Hash)>

Brand Viewset

Parameters:

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

    the optional parameters

Returns:

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

    Brand data, response status code and response headers



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/authentik/api/api/core_api.rb', line 1362

def core_brands_create_with_http_info(brand_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_brands_create ...'
  end
  # verify the required parameter 'brand_request' is set
  if @api_client.config.client_side_validation && brand_request.nil?
    fail ArgumentError, "Missing the required parameter 'brand_request' when calling CoreApi.core_brands_create"
  end
  # resource path
  local_var_path = '/core/brands/'

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

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

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

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

#core_brands_current_retrieve(opts = {}) ⇒ CurrentBrand

Get current brand

Parameters:

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

    the optional parameters

Returns:



1418
1419
1420
1421
 
# File 'lib/authentik/api/api/core_api.rb', line 1418

def core_brands_current_retrieve(opts = {})
  data, _status_code, _headers = core_brands_current_retrieve_with_http_info(opts)
  data
end

#core_brands_current_retrieve_with_http_info(opts = {}) ⇒ Array<(CurrentBrand, Integer, Hash)>

Get current brand

Parameters:

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

    the optional parameters

Returns:

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

    CurrentBrand data, response status code and response headers



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

def core_brands_current_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_brands_current_retrieve ...'
  end
  # resource path
  local_var_path = '/core/brands/current/'

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

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

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

#core_brands_destroy(brand_uuid, opts = {}) ⇒ nil

Brand Viewset

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Returns:

  • (nil) 


1474
1475
1476
1477
 
# File 'lib/authentik/api/api/core_api.rb', line 1474

def core_brands_destroy(brand_uuid, opts = {})
  core_brands_destroy_with_http_info(brand_uuid, opts)
  nil
end

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

Brand Viewset

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/authentik/api/api/core_api.rb', line 1483

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

#core_brands_list(opts = {}) ⇒ PaginatedBrandList

Brand Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :brand_uuid (String)
  • :branding_default_flow_background (String)
  • :branding_favicon (String)
  • :branding_logo (String)
  • :branding_title (String)
  • :client_certificates (Array<String>)
  • :default (Boolean)
  • :domain (String)
  • :flow_authentication (String)
  • :flow_device_code (String)
  • :flow_invalidation (String)
  • :flow_lockdown (String)
  • :flow_recovery (String)
  • :flow_unenrollment (String)
  • :flow_user_settings (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.

  • :web_certificate (String)

Returns:



1554
1555
1556
1557
 
# File 'lib/authentik/api/api/core_api.rb', line 1554

def core_brands_list(opts = {})
  data, _status_code, _headers = core_brands_list_with_http_info(opts)
  data
end

#core_brands_list_with_http_info(opts = {}) ⇒ Array<(PaginatedBrandList, Integer, Hash)>

Brand Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :brand_uuid (String)
  • :branding_default_flow_background (String)
  • :branding_favicon (String)
  • :branding_logo (String)
  • :branding_title (String)
  • :client_certificates (Array<String>)
  • :default (Boolean)
  • :domain (String)
  • :flow_authentication (String)
  • :flow_device_code (String)
  • :flow_invalidation (String)
  • :flow_lockdown (String)
  • :flow_recovery (String)
  • :flow_unenrollment (String)
  • :flow_user_settings (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.

  • :web_certificate (String)

Returns:

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

    PaginatedBrandList data, response status code and response headers



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
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
 
# File 'lib/authentik/api/api/core_api.rb', line 1582

def core_brands_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_brands_list ...'
  end
  # resource path
  local_var_path = '/core/brands/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'brand_uuid'] = opts[:'brand_uuid'] if !opts[:'brand_uuid'].nil?
  query_params[:'branding_default_flow_background'] = opts[:'branding_default_flow_background'] if !opts[:'branding_default_flow_background'].nil?
  query_params[:'branding_favicon'] = opts[:'branding_favicon'] if !opts[:'branding_favicon'].nil?
  query_params[:'branding_logo'] = opts[:'branding_logo'] if !opts[:'branding_logo'].nil?
  query_params[:'branding_title'] = opts[:'branding_title'] if !opts[:'branding_title'].nil?
  query_params[:'client_certificates'] = @api_client.build_collection_param(opts[:'client_certificates'], :multi) if !opts[:'client_certificates'].nil?
  query_params[:'default'] = opts[:'default'] if !opts[:'default'].nil?
  query_params[:'domain'] = opts[:'domain'] if !opts[:'domain'].nil?
  query_params[:'flow_authentication'] = opts[:'flow_authentication'] if !opts[:'flow_authentication'].nil?
  query_params[:'flow_device_code'] = opts[:'flow_device_code'] if !opts[:'flow_device_code'].nil?
  query_params[:'flow_invalidation'] = opts[:'flow_invalidation'] if !opts[:'flow_invalidation'].nil?
  query_params[:'flow_lockdown'] = opts[:'flow_lockdown'] if !opts[:'flow_lockdown'].nil?
  query_params[:'flow_recovery'] = opts[:'flow_recovery'] if !opts[:'flow_recovery'].nil?
  query_params[:'flow_unenrollment'] = opts[:'flow_unenrollment'] if !opts[:'flow_unenrollment'].nil?
  query_params[:'flow_user_settings'] = opts[:'flow_user_settings'] if !opts[:'flow_user_settings'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'web_certificate'] = opts[:'web_certificate'] if !opts[:'web_certificate'].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] || 'PaginatedBrandList'

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

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

#core_brands_partial_update(brand_uuid, opts = {}) ⇒ Brand

Brand Viewset

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Options Hash (opts):

Returns:



1651
1652
1653
1654
 
# File 'lib/authentik/api/api/core_api.rb', line 1651

def core_brands_partial_update(brand_uuid, opts = {})
  data, _status_code, _headers = core_brands_partial_update_with_http_info(brand_uuid, opts)
  data
end

#core_brands_partial_update_with_http_info(brand_uuid, opts = {}) ⇒ Array<(Brand, Integer, Hash)>

Brand Viewset

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Brand data, response status code and response headers



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
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
 
# File 'lib/authentik/api/api/core_api.rb', line 1661

def core_brands_partial_update_with_http_info(brand_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_brands_partial_update ...'
  end
  # verify the required parameter 'brand_uuid' is set
  if @api_client.config.client_side_validation && brand_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'brand_uuid' when calling CoreApi.core_brands_partial_update"
  end
  # resource path
  local_var_path = '/core/brands/{brand_uuid}/'.sub('{brand_uuid}', CGI.escape(brand_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_brand_request'])

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

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

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

#core_brands_retrieve(brand_uuid, opts = {}) ⇒ Brand

Brand Viewset

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Returns:



1718
1719
1720
1721
 
# File 'lib/authentik/api/api/core_api.rb', line 1718

def core_brands_retrieve(brand_uuid, opts = {})
  data, _status_code, _headers = core_brands_retrieve_with_http_info(brand_uuid, opts)
  data
end

#core_brands_retrieve_with_http_info(brand_uuid, opts = {}) ⇒ Array<(Brand, Integer, Hash)>

Brand Viewset

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Returns:

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

    Brand data, response status code and response headers



1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
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
 
# File 'lib/authentik/api/api/core_api.rb', line 1727

def core_brands_retrieve_with_http_info(brand_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_brands_retrieve ...'
  end
  # verify the required parameter 'brand_uuid' is set
  if @api_client.config.client_side_validation && brand_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'brand_uuid' when calling CoreApi.core_brands_retrieve"
  end
  # resource path
  local_var_path = '/core/brands/{brand_uuid}/'.sub('{brand_uuid}', CGI.escape(brand_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] || 'Brand'

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

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

#core_brands_update(brand_uuid, brand_request, opts = {}) ⇒ Brand

Brand Viewset

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Returns:



1780
1781
1782
1783
 
# File 'lib/authentik/api/api/core_api.rb', line 1780

def core_brands_update(brand_uuid, brand_request, opts = {})
  data, _status_code, _headers = core_brands_update_with_http_info(brand_uuid, brand_request, opts)
  data
end

#core_brands_update_with_http_info(brand_uuid, brand_request, opts = {}) ⇒ Array<(Brand, Integer, Hash)>

Brand Viewset

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Returns:

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

    Brand data, response status code and response headers



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
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
 
# File 'lib/authentik/api/api/core_api.rb', line 1790

def core_brands_update_with_http_info(brand_uuid, brand_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_brands_update ...'
  end
  # verify the required parameter 'brand_uuid' is set
  if @api_client.config.client_side_validation && brand_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'brand_uuid' when calling CoreApi.core_brands_update"
  end
  # verify the required parameter 'brand_request' is set
  if @api_client.config.client_side_validation && brand_request.nil?
    fail ArgumentError, "Missing the required parameter 'brand_request' when calling CoreApi.core_brands_update"
  end
  # resource path
  local_var_path = '/core/brands/{brand_uuid}/'.sub('{brand_uuid}', CGI.escape(brand_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(brand_request)

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

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

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

#core_brands_used_by_list(brand_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Returns:



1851
1852
1853
1854
 
# File 'lib/authentik/api/api/core_api.rb', line 1851

def core_brands_used_by_list(brand_uuid, opts = {})
  data, _status_code, _headers = core_brands_used_by_list_with_http_info(brand_uuid, opts)
  data
end

#core_brands_used_by_list_with_http_info(brand_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • brand_uuid (String) —

    A UUID string identifying this Brand.

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

    the optional parameters

Returns:

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

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



1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
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
 
# File 'lib/authentik/api/api/core_api.rb', line 1860

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

#core_groups_add_user_create(group_uuid, user_account_request, opts = {}) ⇒ nil

Add user to group

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:

  • (nil) 


1913
1914
1915
1916
 
# File 'lib/authentik/api/api/core_api.rb', line 1913

def core_groups_add_user_create(group_uuid, , opts = {})
  core_groups_add_user_create_with_http_info(group_uuid, , opts)
  nil
end

#core_groups_add_user_create_with_http_info(group_uuid, user_account_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add user to group

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
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
 
# File 'lib/authentik/api/api/core_api.rb', line 1923

def core_groups_add_user_create_with_http_info(group_uuid, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_groups_add_user_create ...'
  end
  # verify the required parameter 'group_uuid' is set
  if @api_client.config.client_side_validation && group_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'group_uuid' when calling CoreApi.core_groups_add_user_create"
  end
  # verify the required parameter 'user_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'user_account_request' when calling CoreApi.core_groups_add_user_create"
  end
  # resource path
  local_var_path = '/core/groups/{group_uuid}/add_user/'.sub('{group_uuid}', CGI.escape(group_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()

  # return_type
  return_type = opts[:debug_return_type]

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

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

#core_groups_create(group_request, opts = {}) ⇒ Group

Group Viewset

Parameters:

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

    the optional parameters

Returns:



1984
1985
1986
1987
 
# File 'lib/authentik/api/api/core_api.rb', line 1984

def core_groups_create(group_request, opts = {})
  data, _status_code, _headers = core_groups_create_with_http_info(group_request, opts)
  data
end

#core_groups_create_with_http_info(group_request, opts = {}) ⇒ Array<(Group, Integer, Hash)>

Group Viewset

Parameters:

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

    the optional parameters

Returns:

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

    Group data, response status code and response headers



1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
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
 
# File 'lib/authentik/api/api/core_api.rb', line 1993

def core_groups_create_with_http_info(group_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_groups_create ...'
  end
  # verify the required parameter 'group_request' is set
  if @api_client.config.client_side_validation && group_request.nil?
    fail ArgumentError, "Missing the required parameter 'group_request' when calling CoreApi.core_groups_create"
  end
  # resource path
  local_var_path = '/core/groups/'

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

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

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

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

#core_groups_destroy(group_uuid, opts = {}) ⇒ nil

Group Viewset

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:

  • (nil) 


2050
2051
2052
2053
 
# File 'lib/authentik/api/api/core_api.rb', line 2050

def core_groups_destroy(group_uuid, opts = {})
  core_groups_destroy_with_http_info(group_uuid, opts)
  nil
end

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

Group Viewset

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
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
 
# File 'lib/authentik/api/api/core_api.rb', line 2059

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

#core_groups_list(opts = {}) ⇒ PaginatedGroupList

Group Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :attributes (String) —

    Attributes

  • :include_children (Boolean) — default: default to false
  • :include_inherited_roles (Boolean) — default: default to false
  • :include_parents (Boolean) — default: default to false
  • :include_users (Boolean) — default: default to true
  • :is_superuser (Boolean)
  • :members_by_pk (Array<Integer>)
  • :members_by_username (Array<String>) —

    Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

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



2123
2124
2125
2126
 
# File 'lib/authentik/api/api/core_api.rb', line 2123

def core_groups_list(opts = {})
  data, _status_code, _headers = core_groups_list_with_http_info(opts)
  data
end

#core_groups_list_with_http_info(opts = {}) ⇒ Array<(PaginatedGroupList, Integer, Hash)>

Group Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :attributes (String) —

    Attributes

  • :include_children (Boolean) — default: default to false
  • :include_inherited_roles (Boolean) — default: default to false
  • :include_parents (Boolean) — default: default to false
  • :include_users (Boolean) — default: default to true
  • :is_superuser (Boolean)
  • :members_by_pk (Array<Integer>)
  • :members_by_username (Array<String>) —

    Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

  • :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<(PaginatedGroupList, Integer, Hash)>) —

    PaginatedGroupList data, response status code and response headers



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
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
 
# File 'lib/authentik/api/api/core_api.rb', line 2144

def core_groups_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_groups_list ...'
  end
  # resource path
  local_var_path = '/core/groups/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'attributes'] = opts[:'attributes'] if !opts[:'attributes'].nil?
  query_params[:'include_children'] = opts[:'include_children'] if !opts[:'include_children'].nil?
  query_params[:'include_inherited_roles'] = opts[:'include_inherited_roles'] if !opts[:'include_inherited_roles'].nil?
  query_params[:'include_parents'] = opts[:'include_parents'] if !opts[:'include_parents'].nil?
  query_params[:'include_users'] = opts[:'include_users'] if !opts[:'include_users'].nil?
  query_params[:'is_superuser'] = opts[:'is_superuser'] if !opts[:'is_superuser'].nil?
  query_params[:'members_by_pk'] = @api_client.build_collection_param(opts[:'members_by_pk'], :multi) if !opts[:'members_by_pk'].nil?
  query_params[:'members_by_username'] = @api_client.build_collection_param(opts[:'members_by_username'], :multi) if !opts[:'members_by_username'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

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

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

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

#core_groups_partial_update(group_uuid, opts = {}) ⇒ Group

Group Viewset

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Options Hash (opts):

Returns:



2206
2207
2208
2209
 
# File 'lib/authentik/api/api/core_api.rb', line 2206

def core_groups_partial_update(group_uuid, opts = {})
  data, _status_code, _headers = core_groups_partial_update_with_http_info(group_uuid, opts)
  data
end

#core_groups_partial_update_with_http_info(group_uuid, opts = {}) ⇒ Array<(Group, Integer, Hash)>

Group Viewset

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Group data, response status code and response headers



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
2260
2261
2262
2263
2264
2265
2266
2267
 
# File 'lib/authentik/api/api/core_api.rb', line 2216

def core_groups_partial_update_with_http_info(group_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_groups_partial_update ...'
  end
  # verify the required parameter 'group_uuid' is set
  if @api_client.config.client_side_validation && group_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'group_uuid' when calling CoreApi.core_groups_partial_update"
  end
  # resource path
  local_var_path = '/core/groups/{group_uuid}/'.sub('{group_uuid}', CGI.escape(group_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_group_request'])

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

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

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

#core_groups_remove_user_create(group_uuid, user_account_request, opts = {}) ⇒ nil

Remove user from group

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:

  • (nil) 


2274
2275
2276
2277
 
# File 'lib/authentik/api/api/core_api.rb', line 2274

def core_groups_remove_user_create(group_uuid, , opts = {})
  core_groups_remove_user_create_with_http_info(group_uuid, , opts)
  nil
end

#core_groups_remove_user_create_with_http_info(group_uuid, user_account_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove user from group

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
 
# File 'lib/authentik/api/api/core_api.rb', line 2284

def core_groups_remove_user_create_with_http_info(group_uuid, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_groups_remove_user_create ...'
  end
  # verify the required parameter 'group_uuid' is set
  if @api_client.config.client_side_validation && group_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'group_uuid' when calling CoreApi.core_groups_remove_user_create"
  end
  # verify the required parameter 'user_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'user_account_request' when calling CoreApi.core_groups_remove_user_create"
  end
  # resource path
  local_var_path = '/core/groups/{group_uuid}/remove_user/'.sub('{group_uuid}', CGI.escape(group_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()

  # return_type
  return_type = opts[:debug_return_type]

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

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

#core_groups_retrieve(group_uuid, opts = {}) ⇒ Group

Group Viewset

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Options Hash (opts):

  • :include_children (Boolean) — default: default to false
  • :include_inherited_roles (Boolean) — default: default to false
  • :include_parents (Boolean) — default: default to false
  • :include_users (Boolean) — default: default to true

Returns:



2349
2350
2351
2352
 
# File 'lib/authentik/api/api/core_api.rb', line 2349

def core_groups_retrieve(group_uuid, opts = {})
  data, _status_code, _headers = core_groups_retrieve_with_http_info(group_uuid, opts)
  data
end

#core_groups_retrieve_with_http_info(group_uuid, opts = {}) ⇒ Array<(Group, Integer, Hash)>

Group Viewset

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Options Hash (opts):

  • :include_children (Boolean) — default: default to false
  • :include_inherited_roles (Boolean) — default: default to false
  • :include_parents (Boolean) — default: default to false
  • :include_users (Boolean) — default: default to true

Returns:

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

    Group data, response status code and response headers



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
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
 
# File 'lib/authentik/api/api/core_api.rb', line 2362

def core_groups_retrieve_with_http_info(group_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_groups_retrieve ...'
  end
  # verify the required parameter 'group_uuid' is set
  if @api_client.config.client_side_validation && group_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'group_uuid' when calling CoreApi.core_groups_retrieve"
  end
  # resource path
  local_var_path = '/core/groups/{group_uuid}/'.sub('{group_uuid}', CGI.escape(group_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_children'] = opts[:'include_children'] if !opts[:'include_children'].nil?
  query_params[:'include_inherited_roles'] = opts[:'include_inherited_roles'] if !opts[:'include_inherited_roles'].nil?
  query_params[:'include_parents'] = opts[:'include_parents'] if !opts[:'include_parents'].nil?
  query_params[:'include_users'] = opts[:'include_users'] if !opts[:'include_users'].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] || 'Group'

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

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

#core_groups_update(group_uuid, group_request, opts = {}) ⇒ Group

Group Viewset

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:



2419
2420
2421
2422
 
# File 'lib/authentik/api/api/core_api.rb', line 2419

def core_groups_update(group_uuid, group_request, opts = {})
  data, _status_code, _headers = core_groups_update_with_http_info(group_uuid, group_request, opts)
  data
end

#core_groups_update_with_http_info(group_uuid, group_request, opts = {}) ⇒ Array<(Group, Integer, Hash)>

Group Viewset

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:

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

    Group data, response status code and response headers



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
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
 
# File 'lib/authentik/api/api/core_api.rb', line 2429

def core_groups_update_with_http_info(group_uuid, group_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_groups_update ...'
  end
  # verify the required parameter 'group_uuid' is set
  if @api_client.config.client_side_validation && group_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'group_uuid' when calling CoreApi.core_groups_update"
  end
  # verify the required parameter 'group_request' is set
  if @api_client.config.client_side_validation && group_request.nil?
    fail ArgumentError, "Missing the required parameter 'group_request' when calling CoreApi.core_groups_update"
  end
  # resource path
  local_var_path = '/core/groups/{group_uuid}/'.sub('{group_uuid}', CGI.escape(group_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(group_request)

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

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

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

#core_groups_used_by_list(group_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:



2490
2491
2492
2493
 
# File 'lib/authentik/api/api/core_api.rb', line 2490

def core_groups_used_by_list(group_uuid, opts = {})
  data, _status_code, _headers = core_groups_used_by_list_with_http_info(group_uuid, opts)
  data
end

#core_groups_used_by_list_with_http_info(group_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • group_uuid (String) —

    A UUID string identifying this Group.

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

    the optional parameters

Returns:

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

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



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
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
 
# File 'lib/authentik/api/api/core_api.rb', line 2499

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

#core_tokens_create(token_request, opts = {}) ⇒ Token

Token Viewset

Parameters:

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

    the optional parameters

Returns:



2551
2552
2553
2554
 
# File 'lib/authentik/api/api/core_api.rb', line 2551

def core_tokens_create(token_request, opts = {})
  data, _status_code, _headers = core_tokens_create_with_http_info(token_request, opts)
  data
end

#core_tokens_create_with_http_info(token_request, opts = {}) ⇒ Array<(Token, Integer, Hash)>

Token Viewset

Parameters:

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



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
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
 
# File 'lib/authentik/api/api/core_api.rb', line 2560

def core_tokens_create_with_http_info(token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_tokens_create ...'
  end
  # verify the required parameter 'token_request' is set
  if @api_client.config.client_side_validation && token_request.nil?
    fail ArgumentError, "Missing the required parameter 'token_request' when calling CoreApi.core_tokens_create"
  end
  # resource path
  local_var_path = '/core/tokens/'

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

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

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

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

#core_tokens_destroy(identifier, opts = {}) ⇒ nil

Token Viewset

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2617
2618
2619
2620
 
# File 'lib/authentik/api/api/core_api.rb', line 2617

def core_tokens_destroy(identifier, opts = {})
  core_tokens_destroy_with_http_info(identifier, opts)
  nil
end

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

Token Viewset

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
 
# File 'lib/authentik/api/api/core_api.rb', line 2626

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

#core_tokens_list(opts = {}) ⇒ PaginatedTokenList

Token Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :description (String)
  • :expires (Time)
  • :expiring (Boolean)
  • :identifier (String)
  • :intent (IntentEnum)
  • :managed (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.

  • :user__username (String)

Returns:



2688
2689
2690
2691
 
# File 'lib/authentik/api/api/core_api.rb', line 2688

def core_tokens_list(opts = {})
  data, _status_code, _headers = core_tokens_list_with_http_info(opts)
  data
end

#core_tokens_list_with_http_info(opts = {}) ⇒ Array<(PaginatedTokenList, Integer, Hash)>

Token Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :description (String)
  • :expires (Time)
  • :expiring (Boolean)
  • :identifier (String)
  • :intent (IntentEnum)
  • :managed (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.

  • :user__username (String)

Returns:

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

    PaginatedTokenList data, response status code and response headers



2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
 
# File 'lib/authentik/api/api/core_api.rb', line 2707

def core_tokens_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_tokens_list ...'
  end
  # resource path
  local_var_path = '/core/tokens/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
  query_params[:'expires'] = opts[:'expires'] if !opts[:'expires'].nil?
  query_params[:'expiring'] = opts[:'expiring'] if !opts[:'expiring'].nil?
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'intent'] = opts[:'intent'] if !opts[:'intent'].nil?
  query_params[:'managed'] = opts[:'managed'] if !opts[:'managed'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'user__username'] = opts[:'user__username'] if !opts[:'user__username'].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] || 'PaginatedTokenList'

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

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

#core_tokens_partial_update(identifier, opts = {}) ⇒ Token

Token Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2767
2768
2769
2770
 
# File 'lib/authentik/api/api/core_api.rb', line 2767

def core_tokens_partial_update(identifier, opts = {})
  data, _status_code, _headers = core_tokens_partial_update_with_http_info(identifier, opts)
  data
end

#core_tokens_partial_update_with_http_info(identifier, opts = {}) ⇒ Array<(Token, Integer, Hash)>

Token Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Token data, response status code and response headers



2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
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
 
# File 'lib/authentik/api/api/core_api.rb', line 2777

def core_tokens_partial_update_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_tokens_partial_update ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling CoreApi.core_tokens_partial_update"
  end
  # resource path
  local_var_path = '/core/tokens/{identifier}/'.sub('{identifier}', CGI.escape(identifier.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_token_request'])

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

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

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

#core_tokens_retrieve(identifier, opts = {}) ⇒ Token

Token Viewset

Parameters:

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

    the optional parameters

Returns:



2834
2835
2836
2837
 
# File 'lib/authentik/api/api/core_api.rb', line 2834

def core_tokens_retrieve(identifier, opts = {})
  data, _status_code, _headers = core_tokens_retrieve_with_http_info(identifier, opts)
  data
end

#core_tokens_retrieve_with_http_info(identifier, opts = {}) ⇒ Array<(Token, Integer, Hash)>

Token Viewset

Parameters:

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
 
# File 'lib/authentik/api/api/core_api.rb', line 2843

def core_tokens_retrieve_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_tokens_retrieve ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling CoreApi.core_tokens_retrieve"
  end
  # resource path
  local_var_path = '/core/tokens/{identifier}/'.sub('{identifier}', CGI.escape(identifier.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] || 'Token'

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

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

#core_tokens_set_key_create(identifier, token_set_key_request, opts = {}) ⇒ nil

Set token key. Action is logged as event. ‘authentik_core.set_token_key` permission is required.

Parameters:

  • identifier (String)
  • token_set_key_request (TokenSetKeyRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2896
2897
2898
2899
 
# File 'lib/authentik/api/api/core_api.rb', line 2896

def core_tokens_set_key_create(identifier, token_set_key_request, opts = {})
  core_tokens_set_key_create_with_http_info(identifier, token_set_key_request, opts)
  nil
end

#core_tokens_set_key_create_with_http_info(identifier, token_set_key_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Set token key. Action is logged as event. &#x60;authentik_core.set_token_key&#x60; permission is required.

Parameters:

  • identifier (String)
  • token_set_key_request (TokenSetKeyRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
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
 
# File 'lib/authentik/api/api/core_api.rb', line 2906

def core_tokens_set_key_create_with_http_info(identifier, token_set_key_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_tokens_set_key_create ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling CoreApi.core_tokens_set_key_create"
  end
  # verify the required parameter 'token_set_key_request' is set
  if @api_client.config.client_side_validation && token_set_key_request.nil?
    fail ArgumentError, "Missing the required parameter 'token_set_key_request' when calling CoreApi.core_tokens_set_key_create"
  end
  # resource path
  local_var_path = '/core/tokens/{identifier}/set_key/'.sub('{identifier}', CGI.escape(identifier.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(token_set_key_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#core_tokens_update(identifier, token_request, opts = {}) ⇒ Token

Token Viewset

Parameters:

  • identifier (String)
  • token_request (TokenRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2968
2969
2970
2971
 
# File 'lib/authentik/api/api/core_api.rb', line 2968

def core_tokens_update(identifier, token_request, opts = {})
  data, _status_code, _headers = core_tokens_update_with_http_info(identifier, token_request, opts)
  data
end

#core_tokens_update_with_http_info(identifier, token_request, opts = {}) ⇒ Array<(Token, Integer, Hash)>

Token Viewset

Parameters:

  • identifier (String)
  • token_request (TokenRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Token data, response status code and response headers



2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
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
 
# File 'lib/authentik/api/api/core_api.rb', line 2978

def core_tokens_update_with_http_info(identifier, token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_tokens_update ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling CoreApi.core_tokens_update"
  end
  # verify the required parameter 'token_request' is set
  if @api_client.config.client_side_validation && token_request.nil?
    fail ArgumentError, "Missing the required parameter 'token_request' when calling CoreApi.core_tokens_update"
  end
  # resource path
  local_var_path = '/core/tokens/{identifier}/'.sub('{identifier}', CGI.escape(identifier.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(token_request)

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

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

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

#core_tokens_used_by_list(identifier, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

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

    the optional parameters

Returns:



3039
3040
3041
3042
 
# File 'lib/authentik/api/api/core_api.rb', line 3039

def core_tokens_used_by_list(identifier, opts = {})
  data, _status_code, _headers = core_tokens_used_by_list_with_http_info(identifier, opts)
  data
end

#core_tokens_used_by_list_with_http_info(identifier, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

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

    the optional parameters

Returns:

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

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



3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
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
 
# File 'lib/authentik/api/api/core_api.rb', line 3048

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

#core_tokens_view_key_retrieve(identifier, opts = {}) ⇒ TokenView

Return token key and log access

Parameters:

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

    the optional parameters

Returns:



3100
3101
3102
3103
 
# File 'lib/authentik/api/api/core_api.rb', line 3100

def core_tokens_view_key_retrieve(identifier, opts = {})
  data, _status_code, _headers = core_tokens_view_key_retrieve_with_http_info(identifier, opts)
  data
end

#core_tokens_view_key_retrieve_with_http_info(identifier, opts = {}) ⇒ Array<(TokenView, Integer, Hash)>

Return token key and log access

Parameters:

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

    the optional parameters

Returns:

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

    TokenView data, response status code and response headers



3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
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
 
# File 'lib/authentik/api/api/core_api.rb', line 3109

def core_tokens_view_key_retrieve_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_tokens_view_key_retrieve ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling CoreApi.core_tokens_view_key_retrieve"
  end
  # resource path
  local_var_path = '/core/tokens/{identifier}/view_key/'.sub('{identifier}', CGI.escape(identifier.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] || 'TokenView'

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

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

#core_transactional_applications_update(transaction_application_request, opts = {}) ⇒ TransactionApplicationResponse

Convert data into a blueprint, validate it and apply it

Parameters:

Returns:



3161
3162
3163
3164
 
# File 'lib/authentik/api/api/core_api.rb', line 3161

def core_transactional_applications_update(transaction_application_request, opts = {})
  data, _status_code, _headers = core_transactional_applications_update_with_http_info(transaction_application_request, opts)
  data
end

#core_transactional_applications_update_with_http_info(transaction_application_request, opts = {}) ⇒ Array<(TransactionApplicationResponse, Integer, Hash)>

Convert data into a blueprint, validate it and apply it

Parameters:

Returns:



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
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
 
# File 'lib/authentik/api/api/core_api.rb', line 3170

def core_transactional_applications_update_with_http_info(transaction_application_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_transactional_applications_update ...'
  end
  # verify the required parameter 'transaction_application_request' is set
  if @api_client.config.client_side_validation && transaction_application_request.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_application_request' when calling CoreApi.core_transactional_applications_update"
  end
  # resource path
  local_var_path = '/core/transactional/applications/'

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

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

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

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

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

UserConsent Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User Consent.

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

    the optional parameters

Returns:

  • (nil) 


3227
3228
3229
3230
 
# File 'lib/authentik/api/api/core_api.rb', line 3227

def core_user_consent_destroy(id, opts = {})
  core_user_consent_destroy_with_http_info(id, opts)
  nil
end

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

UserConsent Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User Consent.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/authentik/api/api/core_api.rb', line 3236

def core_user_consent_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_user_consent_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 CoreApi.core_user_consent_destroy"
  end
  # resource path
  local_var_path = '/core/user_consent/{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 => :"CoreApi.core_user_consent_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: CoreApi#core_user_consent_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#core_user_consent_list(opts = {}) ⇒ PaginatedUserConsentList

UserConsent Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :user (Integer)

Returns:



3293
3294
3295
3296
 
# File 'lib/authentik/api/api/core_api.rb', line 3293

def core_user_consent_list(opts = {})
  data, _status_code, _headers = core_user_consent_list_with_http_info(opts)
  data
end

#core_user_consent_list_with_http_info(opts = {}) ⇒ Array<(PaginatedUserConsentList, Integer, Hash)>

UserConsent Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :user (Integer)

Returns:

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

    PaginatedUserConsentList data, response status code and response headers



3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
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
 
# File 'lib/authentik/api/api/core_api.rb', line 3307

def core_user_consent_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_user_consent_list ...'
  end
  # resource path
  local_var_path = '/core/user_consent/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'application'] = opts[:'application'] if !opts[:'application'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'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] || 'PaginatedUserConsentList'

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

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

#core_user_consent_retrieve(id, opts = {}) ⇒ UserConsent

UserConsent Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User Consent.

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

    the optional parameters

Returns:



3361
3362
3363
3364
 
# File 'lib/authentik/api/api/core_api.rb', line 3361

def core_user_consent_retrieve(id, opts = {})
  data, _status_code, _headers = core_user_consent_retrieve_with_http_info(id, opts)
  data
end

#core_user_consent_retrieve_with_http_info(id, opts = {}) ⇒ Array<(UserConsent, Integer, Hash)>

UserConsent Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User Consent.

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

    the optional parameters

Returns:

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

    UserConsent data, response status code and response headers



3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
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
 
# File 'lib/authentik/api/api/core_api.rb', line 3370

def core_user_consent_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_user_consent_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 CoreApi.core_user_consent_retrieve"
  end
  # resource path
  local_var_path = '/core/user_consent/{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] || 'UserConsent'

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

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

#core_user_consent_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 User Consent.

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

    the optional parameters

Returns:



3422
3423
3424
3425
 
# File 'lib/authentik/api/api/core_api.rb', line 3422

def core_user_consent_used_by_list(id, opts = {})
  data, _status_code, _headers = core_user_consent_used_by_list_with_http_info(id, opts)
  data
end

#core_user_consent_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 User Consent.

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

    the optional parameters

Returns:

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

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



3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
 
# File 'lib/authentik/api/api/core_api.rb', line 3431

def core_user_consent_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_user_consent_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 CoreApi.core_user_consent_used_by_list"
  end
  # resource path
  local_var_path = '/core/user_consent/{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 => :"CoreApi.core_user_consent_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: CoreApi#core_user_consent_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#core_users_account_lockdown_create(opts = {}) ⇒ Link

Choose the target account, then return a flow link.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3483
3484
3485
3486
 
# File 'lib/authentik/api/api/core_api.rb', line 3483

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

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

Choose the target account, then return a flow link.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Link data, response status code and response headers



3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
 
# File 'lib/authentik/api/api/core_api.rb', line 3492

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_account_lockdown_create ...'
  end
  # resource path
  local_var_path = '/core/users/account_lockdown/'

  # 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[:'user_account_lockdown_request'])

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

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

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

#core_users_create(user_request, opts = {}) ⇒ User

User Viewset

Parameters:

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

    the optional parameters

Returns:



3545
3546
3547
3548
 
# File 'lib/authentik/api/api/core_api.rb', line 3545

def core_users_create(user_request, opts = {})
  data, _status_code, _headers = core_users_create_with_http_info(user_request, opts)
  data
end

#core_users_create_with_http_info(user_request, opts = {}) ⇒ Array<(User, Integer, Hash)>

User Viewset

Parameters:

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
 
# File 'lib/authentik/api/api/core_api.rb', line 3554

def core_users_create_with_http_info(user_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_create ...'
  end
  # verify the required parameter 'user_request' is set
  if @api_client.config.client_side_validation && user_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_request' when calling CoreApi.core_users_create"
  end
  # resource path
  local_var_path = '/core/users/'

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

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

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

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

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

User Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

  • (nil) 


3611
3612
3613
3614
 
# File 'lib/authentik/api/api/core_api.rb', line 3611

def core_users_destroy(id, opts = {})
  core_users_destroy_with_http_info(id, opts)
  nil
end

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

User Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/authentik/api/api/core_api.rb', line 3620

def core_users_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_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 CoreApi.core_users_destroy"
  end
  # resource path
  local_var_path = '/core/users/{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 => :"CoreApi.core_users_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: CoreApi#core_users_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#core_users_export_create(opts = {}) ⇒ DataExport

Create a data export for this data type. Note that the export is generated asynchronously: this method returns a ‘DataExport` object that will initially have `completed=false` as well as the permanent URL to that object in the `Location` header. You can poll that URL until `completed=true`, at which point the `file_url` property will contain a URL to download

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :attributes (String) —

    Attributes

  • :date_joined (Time)
  • :date_joined__gt (Time)
  • :date_joined__lt (Time)
  • :email (String)
  • :groups_by_name (Array<String>)
  • :groups_by_pk (Array<String>)
  • :is_active (Boolean)
  • :is_superuser (Boolean)
  • :last_login (Time)
  • :last_login__gt (Time)
  • :last_login__isnull (Boolean)
  • :last_login__lt (Time)
  • :last_updated (Time)
  • :last_updated__gt (Time)
  • :last_updated__lt (Time)
  • :name (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :path (String)
  • :path_startswith (String)
  • :roles_by_name (Array<String>)
  • :roles_by_pk (Array<String>)
  • :search (String) —

    A search term.

  • :type (Array<UserTypeEnum>)
  • :username (String)
  • :uuid (String)

Returns:



3697
3698
3699
3700
 
# File 'lib/authentik/api/api/core_api.rb', line 3697

def core_users_export_create(opts = {})
  data, _status_code, _headers = core_users_export_create_with_http_info(opts)
  data
end

#core_users_export_create_with_http_info(opts = {}) ⇒ Array<(DataExport, Integer, Hash)>

Create a data export for this data type. Note that the export is generated asynchronously: this method returns a &#x60;DataExport&#x60; object that will initially have &#x60;completed&#x3D;false&#x60; as well as the permanent URL to that object in the &#x60;Location&#x60; header. You can poll that URL until &#x60;completed&#x3D;true&#x60;, at which point the &#x60;file_url&#x60; property will contain a URL to download

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :attributes (String) —

    Attributes

  • :date_joined (Time)
  • :date_joined__gt (Time)
  • :date_joined__lt (Time)
  • :email (String)
  • :groups_by_name (Array<String>)
  • :groups_by_pk (Array<String>)
  • :is_active (Boolean)
  • :is_superuser (Boolean)
  • :last_login (Time)
  • :last_login__gt (Time)
  • :last_login__isnull (Boolean)
  • :last_login__lt (Time)
  • :last_updated (Time)
  • :last_updated__gt (Time)
  • :last_updated__lt (Time)
  • :name (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :path (String)
  • :path_startswith (String)
  • :roles_by_name (Array<String>)
  • :roles_by_pk (Array<String>)
  • :search (String) —

    A search term.

  • :type (Array<UserTypeEnum>)
  • :username (String)
  • :uuid (String)

Returns:

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

    DataExport data, response status code and response headers



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
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
 
# File 'lib/authentik/api/api/core_api.rb', line 3731

def core_users_export_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_export_create ...'
  end
  # resource path
  local_var_path = '/core/users/export/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'attributes'] = opts[:'attributes'] if !opts[:'attributes'].nil?
  query_params[:'date_joined'] = opts[:'date_joined'] if !opts[:'date_joined'].nil?
  query_params[:'date_joined__gt'] = opts[:'date_joined__gt'] if !opts[:'date_joined__gt'].nil?
  query_params[:'date_joined__lt'] = opts[:'date_joined__lt'] if !opts[:'date_joined__lt'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'groups_by_name'] = @api_client.build_collection_param(opts[:'groups_by_name'], :multi) if !opts[:'groups_by_name'].nil?
  query_params[:'groups_by_pk'] = @api_client.build_collection_param(opts[:'groups_by_pk'], :multi) if !opts[:'groups_by_pk'].nil?
  query_params[:'is_active'] = opts[:'is_active'] if !opts[:'is_active'].nil?
  query_params[:'is_superuser'] = opts[:'is_superuser'] if !opts[:'is_superuser'].nil?
  query_params[:'last_login'] = opts[:'last_login'] if !opts[:'last_login'].nil?
  query_params[:'last_login__gt'] = opts[:'last_login__gt'] if !opts[:'last_login__gt'].nil?
  query_params[:'last_login__isnull'] = opts[:'last_login__isnull'] if !opts[:'last_login__isnull'].nil?
  query_params[:'last_login__lt'] = opts[:'last_login__lt'] if !opts[:'last_login__lt'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].nil?
  query_params[:'last_updated__gt'] = opts[:'last_updated__gt'] if !opts[:'last_updated__gt'].nil?
  query_params[:'last_updated__lt'] = opts[:'last_updated__lt'] if !opts[:'last_updated__lt'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'path_startswith'] = opts[:'path_startswith'] if !opts[:'path_startswith'].nil?
  query_params[:'roles_by_name'] = @api_client.build_collection_param(opts[:'roles_by_name'], :multi) if !opts[:'roles_by_name'].nil?
  query_params[:'roles_by_pk'] = @api_client.build_collection_param(opts[:'roles_by_pk'], :multi) if !opts[:'roles_by_pk'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if !opts[:'type'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
  query_params[:'uuid'] = opts[:'uuid'] if !opts[:'uuid'].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] || 'DataExport'

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

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

#core_users_impersonate_create(id, impersonation_request, opts = {}) ⇒ nil

Impersonate a user

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

  • (nil) 


3806
3807
3808
3809
 
# File 'lib/authentik/api/api/core_api.rb', line 3806

def core_users_impersonate_create(id, impersonation_request, opts = {})
  core_users_impersonate_create_with_http_info(id, impersonation_request, opts)
  nil
end

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

Impersonate a user

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
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
 
# File 'lib/authentik/api/api/core_api.rb', line 3816

def core_users_impersonate_create_with_http_info(id, impersonation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_impersonate_create ...'
  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 CoreApi.core_users_impersonate_create"
  end
  # verify the required parameter 'impersonation_request' is set
  if @api_client.config.client_side_validation && impersonation_request.nil?
    fail ArgumentError, "Missing the required parameter 'impersonation_request' when calling CoreApi.core_users_impersonate_create"
  end
  # resource path
  local_var_path = '/core/users/{id}/impersonate/'.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(impersonation_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#core_users_impersonate_end_retrieve(opts = {}) ⇒ nil

End Impersonation a user

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


3876
3877
3878
3879
 
# File 'lib/authentik/api/api/core_api.rb', line 3876

def core_users_impersonate_end_retrieve(opts = {})
  core_users_impersonate_end_retrieve_with_http_info(opts)
  nil
end

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

End Impersonation a user

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
 
# File 'lib/authentik/api/api/core_api.rb', line 3884

def core_users_impersonate_end_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_impersonate_end_retrieve ...'
  end
  # resource path
  local_var_path = '/core/users/impersonate_end/'

  # 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 => :"CoreApi.core_users_impersonate_end_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: CoreApi#core_users_impersonate_end_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#core_users_list(opts = {}) ⇒ PaginatedUserList

User Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :attributes (String) —

    Attributes

  • :date_joined (Time)
  • :date_joined__gt (Time)
  • :date_joined__lt (Time)
  • :email (String)
  • :groups_by_name (Array<String>)
  • :groups_by_pk (Array<String>)
  • :include_groups (Boolean) — default: default to true
  • :include_roles (Boolean) — default: default to true
  • :is_active (Boolean)
  • :is_superuser (Boolean)
  • :last_login (Time)
  • :last_login__gt (Time)
  • :last_login__isnull (Boolean)
  • :last_login__lt (Time)
  • :last_updated (Time)
  • :last_updated__gt (Time)
  • :last_updated__lt (Time)
  • :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.

  • :path (String)
  • :path_startswith (String)
  • :roles_by_name (Array<String>)
  • :roles_by_pk (Array<String>)
  • :search (String) —

    A search term.

  • :type (Array<UserTypeEnum>)
  • :username (String)
  • :uuid (String)

Returns:



3961
3962
3963
3964
 
# File 'lib/authentik/api/api/core_api.rb', line 3961

def core_users_list(opts = {})
  data, _status_code, _headers = core_users_list_with_http_info(opts)
  data
end

#core_users_list_with_http_info(opts = {}) ⇒ Array<(PaginatedUserList, Integer, Hash)>

User Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :attributes (String) —

    Attributes

  • :date_joined (Time)
  • :date_joined__gt (Time)
  • :date_joined__lt (Time)
  • :email (String)
  • :groups_by_name (Array<String>)
  • :groups_by_pk (Array<String>)
  • :include_groups (Boolean) — default: default to true
  • :include_roles (Boolean) — default: default to true
  • :is_active (Boolean)
  • :is_superuser (Boolean)
  • :last_login (Time)
  • :last_login__gt (Time)
  • :last_login__isnull (Boolean)
  • :last_login__lt (Time)
  • :last_updated (Time)
  • :last_updated__gt (Time)
  • :last_updated__lt (Time)
  • :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.

  • :path (String)
  • :path_startswith (String)
  • :roles_by_name (Array<String>)
  • :roles_by_pk (Array<String>)
  • :search (String) —

    A search term.

  • :type (Array<UserTypeEnum>)
  • :username (String)
  • :uuid (String)

Returns:

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

    PaginatedUserList data, response status code and response headers



3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
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
 
# File 'lib/authentik/api/api/core_api.rb', line 3999

def core_users_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_list ...'
  end
  # resource path
  local_var_path = '/core/users/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'attributes'] = opts[:'attributes'] if !opts[:'attributes'].nil?
  query_params[:'date_joined'] = opts[:'date_joined'] if !opts[:'date_joined'].nil?
  query_params[:'date_joined__gt'] = opts[:'date_joined__gt'] if !opts[:'date_joined__gt'].nil?
  query_params[:'date_joined__lt'] = opts[:'date_joined__lt'] if !opts[:'date_joined__lt'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'groups_by_name'] = @api_client.build_collection_param(opts[:'groups_by_name'], :multi) if !opts[:'groups_by_name'].nil?
  query_params[:'groups_by_pk'] = @api_client.build_collection_param(opts[:'groups_by_pk'], :multi) if !opts[:'groups_by_pk'].nil?
  query_params[:'include_groups'] = opts[:'include_groups'] if !opts[:'include_groups'].nil?
  query_params[:'include_roles'] = opts[:'include_roles'] if !opts[:'include_roles'].nil?
  query_params[:'is_active'] = opts[:'is_active'] if !opts[:'is_active'].nil?
  query_params[:'is_superuser'] = opts[:'is_superuser'] if !opts[:'is_superuser'].nil?
  query_params[:'last_login'] = opts[:'last_login'] if !opts[:'last_login'].nil?
  query_params[:'last_login__gt'] = opts[:'last_login__gt'] if !opts[:'last_login__gt'].nil?
  query_params[:'last_login__isnull'] = opts[:'last_login__isnull'] if !opts[:'last_login__isnull'].nil?
  query_params[:'last_login__lt'] = opts[:'last_login__lt'] if !opts[:'last_login__lt'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].nil?
  query_params[:'last_updated__gt'] = opts[:'last_updated__gt'] if !opts[:'last_updated__gt'].nil?
  query_params[:'last_updated__lt'] = opts[:'last_updated__lt'] if !opts[:'last_updated__lt'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'path_startswith'] = opts[:'path_startswith'] if !opts[:'path_startswith'].nil?
  query_params[:'roles_by_name'] = @api_client.build_collection_param(opts[:'roles_by_name'], :multi) if !opts[:'roles_by_name'].nil?
  query_params[:'roles_by_pk'] = @api_client.build_collection_param(opts[:'roles_by_pk'], :multi) if !opts[:'roles_by_pk'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if !opts[:'type'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
  query_params[:'uuid'] = opts[:'uuid'] if !opts[:'uuid'].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] || 'PaginatedUserList'

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

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

#core_users_me_retrieve(opts = {}) ⇒ SessionUser

Get information about current user

Parameters:

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

    the optional parameters

Returns:



4076
4077
4078
4079
 
# File 'lib/authentik/api/api/core_api.rb', line 4076

def core_users_me_retrieve(opts = {})
  data, _status_code, _headers = core_users_me_retrieve_with_http_info(opts)
  data
end

#core_users_me_retrieve_with_http_info(opts = {}) ⇒ Array<(SessionUser, Integer, Hash)>

Get information about current user

Parameters:

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

    the optional parameters

Returns:

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

    SessionUser data, response status code and response headers



4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
 
# File 'lib/authentik/api/api/core_api.rb', line 4084

def core_users_me_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_me_retrieve ...'
  end
  # resource path
  local_var_path = '/core/users/me/'

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

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

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

#core_users_partial_update(id, opts = {}) ⇒ User

User Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Options Hash (opts):

Returns:



4133
4134
4135
4136
 
# File 'lib/authentik/api/api/core_api.rb', line 4133

def core_users_partial_update(id, opts = {})
  data, _status_code, _headers = core_users_partial_update_with_http_info(id, opts)
  data
end

#core_users_partial_update_with_http_info(id, opts = {}) ⇒ Array<(User, Integer, Hash)>

User Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    User data, response status code and response headers



4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
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
 
# File 'lib/authentik/api/api/core_api.rb', line 4143

def core_users_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_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 CoreApi.core_users_partial_update"
  end
  # resource path
  local_var_path = '/core/users/{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_user_request'])

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

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

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

#core_users_paths_retrieve(opts = {}) ⇒ UserPath

Get all user paths

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    A search term.

Returns:



4200
4201
4202
4203
 
# File 'lib/authentik/api/api/core_api.rb', line 4200

def core_users_paths_retrieve(opts = {})
  data, _status_code, _headers = core_users_paths_retrieve_with_http_info(opts)
  data
end

#core_users_paths_retrieve_with_http_info(opts = {}) ⇒ Array<(UserPath, Integer, Hash)>

Get all user paths

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    A search term.

Returns:

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

    UserPath data, response status code and response headers



4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
 
# File 'lib/authentik/api/api/core_api.rb', line 4209

def core_users_paths_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_paths_retrieve ...'
  end
  # resource path
  local_var_path = '/core/users/paths/'

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

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

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

#core_users_recovery_create(id, opts = {}) ⇒ Link

Create a temporary link that a user can use to recover their account

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Options Hash (opts):

Returns:



4259
4260
4261
4262
 
# File 'lib/authentik/api/api/core_api.rb', line 4259

def core_users_recovery_create(id, opts = {})
  data, _status_code, _headers = core_users_recovery_create_with_http_info(id, opts)
  data
end

#core_users_recovery_create_with_http_info(id, opts = {}) ⇒ Array<(Link, Integer, Hash)>

Create a temporary link that a user can use to recover their account

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Link data, response status code and response headers



4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
 
# File 'lib/authentik/api/api/core_api.rb', line 4269

def core_users_recovery_create_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_recovery_create ...'
  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 CoreApi.core_users_recovery_create"
  end
  # resource path
  local_var_path = '/core/users/{id}/recovery/'.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[:'user_recovery_link_request'])

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

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

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

#core_users_recovery_email_create(id, user_recovery_email_request, opts = {}) ⇒ nil

Send an email with a temporary link that a user can use to recover their account

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

  • (nil) 


4327
4328
4329
4330
 
# File 'lib/authentik/api/api/core_api.rb', line 4327

def core_users_recovery_email_create(id, user_recovery_email_request, opts = {})
  core_users_recovery_email_create_with_http_info(id, user_recovery_email_request, opts)
  nil
end

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

Send an email with a temporary link that a user can use to recover their account

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
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
 
# File 'lib/authentik/api/api/core_api.rb', line 4337

def core_users_recovery_email_create_with_http_info(id, user_recovery_email_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_recovery_email_create ...'
  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 CoreApi.core_users_recovery_email_create"
  end
  # verify the required parameter 'user_recovery_email_request' is set
  if @api_client.config.client_side_validation && user_recovery_email_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_recovery_email_request' when calling CoreApi.core_users_recovery_email_create"
  end
  # resource path
  local_var_path = '/core/users/{id}/recovery_email/'.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(user_recovery_email_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#core_users_retrieve(id, opts = {}) ⇒ User

User Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:



4398
4399
4400
4401
 
# File 'lib/authentik/api/api/core_api.rb', line 4398

def core_users_retrieve(id, opts = {})
  data, _status_code, _headers = core_users_retrieve_with_http_info(id, opts)
  data
end

#core_users_retrieve_with_http_info(id, opts = {}) ⇒ Array<(User, Integer, Hash)>

User Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
 
# File 'lib/authentik/api/api/core_api.rb', line 4407

def core_users_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_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 CoreApi.core_users_retrieve"
  end
  # resource path
  local_var_path = '/core/users/{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] || 'User'

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

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

#core_users_service_account_create(user_service_account_request, opts = {}) ⇒ UserServiceAccountResponse

Create a new user account that is marked as a service account

Parameters:

Returns:



4459
4460
4461
4462
 
# File 'lib/authentik/api/api/core_api.rb', line 4459

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

#core_users_service_account_create_with_http_info(user_service_account_request, opts = {}) ⇒ Array<(UserServiceAccountResponse, Integer, Hash)>

Create a new user account that is marked as a service account

Parameters:

Returns:

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

    UserServiceAccountResponse data, response status code and response headers



4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'lib/authentik/api/api/core_api.rb', line 4468

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_service_account_create ...'
  end
  # verify the required parameter 'user_service_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'user_service_account_request' when calling CoreApi.core_users_service_account_create"
  end
  # resource path
  local_var_path = '/core/users/service_account/'

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

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

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

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

#core_users_set_password_create(id, user_password_set_request, opts = {}) ⇒ nil

Set password for user

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

  • (nil) 


4526
4527
4528
4529
 
# File 'lib/authentik/api/api/core_api.rb', line 4526

def core_users_set_password_create(id, user_password_set_request, opts = {})
  core_users_set_password_create_with_http_info(id, user_password_set_request, opts)
  nil
end

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

Set password for user

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
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
 
# File 'lib/authentik/api/api/core_api.rb', line 4536

def core_users_set_password_create_with_http_info(id, user_password_set_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_set_password_create ...'
  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 CoreApi.core_users_set_password_create"
  end
  # verify the required parameter 'user_password_set_request' is set
  if @api_client.config.client_side_validation && user_password_set_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_password_set_request' when calling CoreApi.core_users_set_password_create"
  end
  # resource path
  local_var_path = '/core/users/{id}/set_password/'.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(user_password_set_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#core_users_set_password_hash_create(id, user_password_hash_set_request, opts = {}) ⇒ nil

Set a user’s password from a pre-hashed Django password value. Submit the Django password hash in the shared “password“ request field. This updates authentik’s local password verifier only. It does not attempt to propagate the password change to LDAP or Kerberos because no raw password is available from the request payload.

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

  • (nil) 


4598
4599
4600
4601
 
# File 'lib/authentik/api/api/core_api.rb', line 4598

def core_users_set_password_hash_create(id, user_password_hash_set_request, opts = {})
  core_users_set_password_hash_create_with_http_info(id, user_password_hash_set_request, opts)
  nil
end

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

Set a user&#39;s password from a pre-hashed Django password value. Submit the Django password hash in the shared &#x60;&#x60;password&#x60;&#x60; request field. This updates authentik&#39;s local password verifier only. It does not attempt to propagate the password change to LDAP or Kerberos because no raw password is available from the request payload.

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
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
 
# File 'lib/authentik/api/api/core_api.rb', line 4608

def core_users_set_password_hash_create_with_http_info(id, user_password_hash_set_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_set_password_hash_create ...'
  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 CoreApi.core_users_set_password_hash_create"
  end
  # verify the required parameter 'user_password_hash_set_request' is set
  if @api_client.config.client_side_validation && user_password_hash_set_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_password_hash_set_request' when calling CoreApi.core_users_set_password_hash_create"
  end
  # resource path
  local_var_path = '/core/users/{id}/set_password_hash/'.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(user_password_hash_set_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#core_users_update(id, user_request, opts = {}) ⇒ User

User Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:



4670
4671
4672
4673
 
# File 'lib/authentik/api/api/core_api.rb', line 4670

def core_users_update(id, user_request, opts = {})
  data, _status_code, _headers = core_users_update_with_http_info(id, user_request, opts)
  data
end

#core_users_update_with_http_info(id, user_request, opts = {}) ⇒ Array<(User, Integer, Hash)>

User Viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this User.

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
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
 
# File 'lib/authentik/api/api/core_api.rb', line 4680

def core_users_update_with_http_info(id, user_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_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 CoreApi.core_users_update"
  end
  # verify the required parameter 'user_request' is set
  if @api_client.config.client_side_validation && user_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_request' when calling CoreApi.core_users_update"
  end
  # resource path
  local_var_path = '/core/users/{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(user_request)

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

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

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

#core_users_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 User.

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

    the optional parameters

Returns:



4741
4742
4743
4744
 
# File 'lib/authentik/api/api/core_api.rb', line 4741

def core_users_used_by_list(id, opts = {})
  data, _status_code, _headers = core_users_used_by_list_with_http_info(id, opts)
  data
end

#core_users_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 User.

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

    the optional parameters

Returns:

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

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



4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
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
 
# File 'lib/authentik/api/api/core_api.rb', line 4750

def core_users_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.core_users_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 CoreApi.core_users_used_by_list"
  end
  # resource path
  local_var_path = '/core/users/{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 => :"CoreApi.core_users_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: CoreApi#core_users_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end