Class: Authentik::Api::PoliciesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PoliciesApi

Returns a new instance of PoliciesApi.



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

def api_client
  @api_client
end

Instance Method Details

#policies_all_cache_clear_create(opts = {}) ⇒ nil

Clear policy cache

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


19
20
21
22
 
# File 'lib/authentik/api/api/policies_api.rb', line 19

def policies_all_cache_clear_create(opts = {})
  policies_all_cache_clear_create_with_http_info(opts)
  nil
end

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

Clear policy cache

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



27
28
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 27

def policies_all_cache_clear_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_all_cache_clear_create ...'
  end
  # resource path
  local_var_path = '/policies/all/cache_clear/'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#policies_all_cache_info_retrieve(opts = {}) ⇒ Cache

Info about cached policies

Parameters:

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

    the optional parameters

Returns:



74
75
76
77
 
# File 'lib/authentik/api/api/policies_api.rb', line 74

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

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

Info about cached policies

Parameters:

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

    the optional parameters

Returns:

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

    Cache data, response status code and response headers



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/authentik/api/api/policies_api.rb', line 82

def policies_all_cache_info_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_all_cache_info_retrieve ...'
  end
  # resource path
  local_var_path = '/policies/all/cache_info/'

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

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

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

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

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

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

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

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

#policies_all_destroy(policy_uuid, opts = {}) ⇒ nil

Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Policy.

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

    the optional parameters

Returns:

  • (nil) 


130
131
132
133
 
# File 'lib/authentik/api/api/policies_api.rb', line 130

def policies_all_destroy(policy_uuid, opts = {})
  policies_all_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/authentik/api/api/policies_api.rb', line 139

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

#policies_all_list(opts = {}) ⇒ PaginatedPolicyList

Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :promptstage__isnull (Boolean)
  • :search (String) —

    A search term.

Returns:



196
197
198
199
 
# File 'lib/authentik/api/api/policies_api.rb', line 196

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

#policies_all_list_with_http_info(opts = {}) ⇒ Array<(PaginatedPolicyList, Integer, Hash)>

Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :promptstage__isnull (Boolean)
  • :search (String) —

    A search term.

Returns:

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

    PaginatedPolicyList data, response status code and response headers



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/authentik/api/api/policies_api.rb', line 210

def policies_all_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_all_list ...'
  end
  # resource path
  local_var_path = '/policies/all/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'bindings__isnull'] = opts[:'bindings__isnull'] if !opts[:'bindings__isnull'].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[:'promptstage__isnull'] = opts[:'promptstage__isnull'] if !opts[:'promptstage__isnull'].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] || 'PaginatedPolicyList'

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

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

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

#policies_all_retrieve(policy_uuid, opts = {}) ⇒ Policy

Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Policy.

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

    the optional parameters

Returns:



264
265
266
267
 
# File 'lib/authentik/api/api/policies_api.rb', line 264

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

#policies_all_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Policy, Integer, Hash)>

Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Policy.

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

    the optional parameters

Returns:

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

    Policy data, response status code and response headers



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/authentik/api/api/policies_api.rb', line 273

def policies_all_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_all_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_all_retrieve"
  end
  # resource path
  local_var_path = '/policies/all/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'Policy'

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

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

#policies_all_test_create(policy_uuid, policy_test_request, opts = {}) ⇒ PolicyTestResult

Test policy

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Policy.

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

    the optional parameters

Returns:



326
327
328
329
 
# File 'lib/authentik/api/api/policies_api.rb', line 326

def policies_all_test_create(policy_uuid, policy_test_request, opts = {})
  data, _status_code, _headers = policies_all_test_create_with_http_info(policy_uuid, policy_test_request, opts)
  data
end

#policies_all_test_create_with_http_info(policy_uuid, policy_test_request, opts = {}) ⇒ Array<(PolicyTestResult, Integer, Hash)>

Test policy

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Policy.

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

    the optional parameters

Returns:

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

    PolicyTestResult data, response status code and response headers



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/authentik/api/api/policies_api.rb', line 336

def policies_all_test_create_with_http_info(policy_uuid, policy_test_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_all_test_create ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_all_test_create"
  end
  # verify the required parameter 'policy_test_request' is set
  if @api_client.config.client_side_validation && policy_test_request.nil?
    fail ArgumentError, "Missing the required parameter 'policy_test_request' when calling PoliciesApi.policies_all_test_create"
  end
  # resource path
  local_var_path = '/policies/all/{policy_uuid}/test/'.sub('{policy_uuid}', CGI.escape(policy_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(policy_test_request)

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

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

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

#policies_all_types_list(opts = {}) ⇒ Array<TypeCreate>

Get all creatable types

Parameters:

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

    the optional parameters

Returns:



396
397
398
399
 
# File 'lib/authentik/api/api/policies_api.rb', line 396

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

#policies_all_types_list_with_http_info(opts = {}) ⇒ Array<(Array<TypeCreate>, Integer, Hash)>

Get all creatable types

Parameters:

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

    the optional parameters

Returns:

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

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



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/authentik/api/api/policies_api.rb', line 404

def policies_all_types_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_all_types_list ...'
  end
  # resource path
  local_var_path = '/policies/all/types/'

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

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

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

#policies_all_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Policy.

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

    the optional parameters

Returns:



452
453
454
455
 
# File 'lib/authentik/api/api/policies_api.rb', line 452

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

#policies_all_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Policy.

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

    the optional parameters

Returns:

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

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



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/authentik/api/api/policies_api.rb', line 461

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

#policies_bindings_create(policy_binding_request, opts = {}) ⇒ PolicyBinding

PolicyBinding Viewset

Parameters:

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

    the optional parameters

Returns:



513
514
515
516
 
# File 'lib/authentik/api/api/policies_api.rb', line 513

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

#policies_bindings_create_with_http_info(policy_binding_request, opts = {}) ⇒ Array<(PolicyBinding, Integer, Hash)>

PolicyBinding Viewset

Parameters:

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

    the optional parameters

Returns:

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

    PolicyBinding data, response status code and response headers



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

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

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

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

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

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

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

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

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

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

#policies_bindings_destroy(policy_binding_uuid, opts = {}) ⇒ nil

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Returns:

  • (nil) 


579
580
581
582
 
# File 'lib/authentik/api/api/policies_api.rb', line 579

def policies_bindings_destroy(policy_binding_uuid, opts = {})
  policies_bindings_destroy_with_http_info(policy_binding_uuid, opts)
  nil
end

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

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def policies_bindings_destroy_with_http_info(policy_binding_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_bindings_destroy ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling PoliciesApi.policies_bindings_destroy"
  end
  # resource path
  local_var_path = '/policies/bindings/{policy_binding_uuid}/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_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 => :"PoliciesApi.policies_bindings_destroy",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#policies_bindings_list(opts = {}) ⇒ PaginatedPolicyBindingList

PolicyBinding Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :enabled (Boolean)
  • :order (Integer)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :policy (String)
  • :policy__isnull (Boolean)
  • :search (String) —

    A search term.

  • :target (String)
  • :target_in (Array<String>)
  • :timeout (Integer)

Returns:



650
651
652
653
 
# File 'lib/authentik/api/api/policies_api.rb', line 650

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

#policies_bindings_list_with_http_info(opts = {}) ⇒ Array<(PaginatedPolicyBindingList, Integer, Hash)>

PolicyBinding Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :enabled (Boolean)
  • :order (Integer)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :policy (String)
  • :policy__isnull (Boolean)
  • :search (String) —

    A search term.

  • :target (String)
  • :target_in (Array<String>)
  • :timeout (Integer)

Returns:

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

    PaginatedPolicyBindingList data, response status code and response headers



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/authentik/api/api/policies_api.rb', line 669

def policies_bindings_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_bindings_list ...'
  end
  # resource path
  local_var_path = '/policies/bindings/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'enabled'] = opts[:'enabled'] if !opts[:'enabled'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'policy'] = opts[:'policy'] if !opts[:'policy'].nil?
  query_params[:'policy__isnull'] = opts[:'policy__isnull'] if !opts[:'policy__isnull'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'target'] = opts[:'target'] if !opts[:'target'].nil?
  query_params[:'target_in'] = @api_client.build_collection_param(opts[:'target_in'], :multi) if !opts[:'target_in'].nil?
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].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] || 'PaginatedPolicyBindingList'

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

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

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

#policies_bindings_partial_update(policy_binding_uuid, opts = {}) ⇒ PolicyBinding

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Options Hash (opts):

Returns:



729
730
731
732
 
# File 'lib/authentik/api/api/policies_api.rb', line 729

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

#policies_bindings_partial_update_with_http_info(policy_binding_uuid, opts = {}) ⇒ Array<(PolicyBinding, Integer, Hash)>

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PolicyBinding data, response status code and response headers



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
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/authentik/api/api/policies_api.rb', line 739

def policies_bindings_partial_update_with_http_info(policy_binding_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_bindings_partial_update ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling PoliciesApi.policies_bindings_partial_update"
  end
  # resource path
  local_var_path = '/policies/bindings/{policy_binding_uuid}/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_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_policy_binding_request'])

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

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

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

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

#policies_bindings_retrieve(policy_binding_uuid, opts = {}) ⇒ PolicyBinding

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Returns:



796
797
798
799
 
# File 'lib/authentik/api/api/policies_api.rb', line 796

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

#policies_bindings_retrieve_with_http_info(policy_binding_uuid, opts = {}) ⇒ Array<(PolicyBinding, Integer, Hash)>

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Returns:

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

    PolicyBinding data, response status code and response headers



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
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/authentik/api/api/policies_api.rb', line 805

def policies_bindings_retrieve_with_http_info(policy_binding_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_bindings_retrieve ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling PoliciesApi.policies_bindings_retrieve"
  end
  # resource path
  local_var_path = '/policies/bindings/{policy_binding_uuid}/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_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] || 'PolicyBinding'

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

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

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

#policies_bindings_update(policy_binding_uuid, policy_binding_request, opts = {}) ⇒ PolicyBinding

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Returns:



858
859
860
861
 
# File 'lib/authentik/api/api/policies_api.rb', line 858

def policies_bindings_update(policy_binding_uuid, policy_binding_request, opts = {})
  data, _status_code, _headers = policies_bindings_update_with_http_info(policy_binding_uuid, policy_binding_request, opts)
  data
end

#policies_bindings_update_with_http_info(policy_binding_uuid, policy_binding_request, opts = {}) ⇒ Array<(PolicyBinding, Integer, Hash)>

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Returns:

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

    PolicyBinding data, response status code and response headers



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
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/authentik/api/api/policies_api.rb', line 868

def policies_bindings_update_with_http_info(policy_binding_uuid, policy_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_bindings_update ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling PoliciesApi.policies_bindings_update"
  end
  # verify the required parameter 'policy_binding_request' is set
  if @api_client.config.client_side_validation && policy_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_request' when calling PoliciesApi.policies_bindings_update"
  end
  # resource path
  local_var_path = '/policies/bindings/{policy_binding_uuid}/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_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(policy_binding_request)

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

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

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

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

#policies_bindings_used_by_list(policy_binding_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Returns:



929
930
931
932
 
# File 'lib/authentik/api/api/policies_api.rb', line 929

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

#policies_bindings_used_by_list_with_http_info(policy_binding_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Policy Binding.

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

    the optional parameters

Returns:

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

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



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
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
 
# File 'lib/authentik/api/api/policies_api.rb', line 938

def policies_bindings_used_by_list_with_http_info(policy_binding_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_bindings_used_by_list ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling PoliciesApi.policies_bindings_used_by_list"
  end
  # resource path
  local_var_path = '/policies/bindings/{policy_binding_uuid}/used_by/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_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 => :"PoliciesApi.policies_bindings_used_by_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#policies_dummy_create(dummy_policy_request, opts = {}) ⇒ DummyPolicy

Dummy Viewset

Parameters:

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

    the optional parameters

Returns:



990
991
992
993
 
# File 'lib/authentik/api/api/policies_api.rb', line 990

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

#policies_dummy_create_with_http_info(dummy_policy_request, opts = {}) ⇒ Array<(DummyPolicy, Integer, Hash)>

Dummy Viewset

Parameters:

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

    the optional parameters

Returns:

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

    DummyPolicy data, response status code and response headers



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
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/authentik/api/api/policies_api.rb', line 999

def policies_dummy_create_with_http_info(dummy_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_dummy_create ...'
  end
  # verify the required parameter 'dummy_policy_request' is set
  if @api_client.config.client_side_validation && dummy_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'dummy_policy_request' when calling PoliciesApi.policies_dummy_create"
  end
  # resource path
  local_var_path = '/policies/dummy/'

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

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

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

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

#policies_dummy_destroy(policy_uuid, opts = {}) ⇒ nil

Dummy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Returns:

  • (nil) 


1056
1057
1058
1059
 
# File 'lib/authentik/api/api/policies_api.rb', line 1056

def policies_dummy_destroy(policy_uuid, opts = {})
  policies_dummy_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

Dummy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'lib/authentik/api/api/policies_api.rb', line 1065

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

#policies_dummy_list(opts = {}) ⇒ PaginatedDummyPolicyList

Dummy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created (Time)
  • :execution_logging (Boolean)
  • :last_updated (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.

  • :policy_uuid (String)
  • :result (Boolean)
  • :search (String) —

    A search term.

  • :wait_max (Integer)
  • :wait_min (Integer)

Returns:



1128
1129
1130
1131
 
# File 'lib/authentik/api/api/policies_api.rb', line 1128

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

#policies_dummy_list_with_http_info(opts = {}) ⇒ Array<(PaginatedDummyPolicyList, Integer, Hash)>

Dummy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created (Time)
  • :execution_logging (Boolean)
  • :last_updated (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.

  • :policy_uuid (String)
  • :result (Boolean)
  • :search (String) —

    A search term.

  • :wait_max (Integer)
  • :wait_min (Integer)

Returns:

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

    PaginatedDummyPolicyList data, response status code and response headers



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

def policies_dummy_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_dummy_list ...'
  end
  # resource path
  local_var_path = '/policies/dummy/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'execution_logging'] = opts[:'execution_logging'] if !opts[:'execution_logging'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].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[:'policy_uuid'] = opts[:'policy_uuid'] if !opts[:'policy_uuid'].nil?
  query_params[:'result'] = opts[:'result'] if !opts[:'result'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'wait_max'] = opts[:'wait_max'] if !opts[:'wait_max'].nil?
  query_params[:'wait_min'] = opts[:'wait_min'] if !opts[:'wait_min'].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] || 'PaginatedDummyPolicyList'

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

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

#policies_dummy_partial_update(policy_uuid, opts = {}) ⇒ DummyPolicy

Dummy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Options Hash (opts):

Returns:



1209
1210
1211
1212
 
# File 'lib/authentik/api/api/policies_api.rb', line 1209

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

#policies_dummy_partial_update_with_http_info(policy_uuid, opts = {}) ⇒ Array<(DummyPolicy, Integer, Hash)>

Dummy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DummyPolicy data, response status code and response headers



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

def policies_dummy_partial_update_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_dummy_partial_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_dummy_partial_update"
  end
  # resource path
  local_var_path = '/policies/dummy/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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_dummy_policy_request'])

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

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

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

#policies_dummy_retrieve(policy_uuid, opts = {}) ⇒ DummyPolicy

Dummy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Returns:



1276
1277
1278
1279
 
# File 'lib/authentik/api/api/policies_api.rb', line 1276

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

#policies_dummy_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(DummyPolicy, Integer, Hash)>

Dummy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Returns:

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

    DummyPolicy data, response status code and response headers



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

def policies_dummy_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_dummy_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_dummy_retrieve"
  end
  # resource path
  local_var_path = '/policies/dummy/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'DummyPolicy'

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

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

#policies_dummy_update(policy_uuid, dummy_policy_request, opts = {}) ⇒ DummyPolicy

Dummy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Returns:



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

def policies_dummy_update(policy_uuid, dummy_policy_request, opts = {})
  data, _status_code, _headers = policies_dummy_update_with_http_info(policy_uuid, dummy_policy_request, opts)
  data
end

#policies_dummy_update_with_http_info(policy_uuid, dummy_policy_request, opts = {}) ⇒ Array<(DummyPolicy, Integer, Hash)>

Dummy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Returns:

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

    DummyPolicy data, response status code and response headers



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

def policies_dummy_update_with_http_info(policy_uuid, dummy_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_dummy_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_dummy_update"
  end
  # verify the required parameter 'dummy_policy_request' is set
  if @api_client.config.client_side_validation && dummy_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'dummy_policy_request' when calling PoliciesApi.policies_dummy_update"
  end
  # resource path
  local_var_path = '/policies/dummy/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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(dummy_policy_request)

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

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

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

#policies_dummy_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Returns:



1409
1410
1411
1412
 
# File 'lib/authentik/api/api/policies_api.rb', line 1409

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

#policies_dummy_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Dummy Policy.

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

    the optional parameters

Returns:

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

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



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

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

#policies_event_matcher_create(event_matcher_policy_request, opts = {}) ⇒ EventMatcherPolicy

Event Matcher Policy Viewset

Parameters:

Returns:



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

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

#policies_event_matcher_create_with_http_info(event_matcher_policy_request, opts = {}) ⇒ Array<(EventMatcherPolicy, Integer, Hash)>

Event Matcher Policy Viewset

Parameters:

Returns:

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

    EventMatcherPolicy data, response status code and response headers



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

def policies_event_matcher_create_with_http_info(event_matcher_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_event_matcher_create ...'
  end
  # verify the required parameter 'event_matcher_policy_request' is set
  if @api_client.config.client_side_validation && event_matcher_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'event_matcher_policy_request' when calling PoliciesApi.policies_event_matcher_create"
  end
  # resource path
  local_var_path = '/policies/event_matcher/'

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

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

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

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

#policies_event_matcher_destroy(policy_uuid, opts = {}) ⇒ nil

Event Matcher Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Returns:

  • (nil) 


1536
1537
1538
1539
 
# File 'lib/authentik/api/api/policies_api.rb', line 1536

def policies_event_matcher_destroy(policy_uuid, opts = {})
  policies_event_matcher_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

Event Matcher Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#policies_event_matcher_list(opts = {}) ⇒ PaginatedEventMatcherPolicyList

Event Matcher Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    Match created events with this action type. When left empty, all action types will be matched.

  • :app (String)
  • :client_ip (String)
  • :created (Time)
  • :execution_logging (Boolean)
  • :last_updated (Time)
  • :model (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.

  • :policy_uuid (String)
  • :search (String) —

    A search term.

Returns:



1609
1610
1611
1612
 
# File 'lib/authentik/api/api/policies_api.rb', line 1609

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

#policies_event_matcher_list_with_http_info(opts = {}) ⇒ Array<(PaginatedEventMatcherPolicyList, Integer, Hash)>

Event Matcher Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    Match created events with this action type. When left empty, all action types will be matched.

  • :app (String)
  • :client_ip (String)
  • :created (Time)
  • :execution_logging (Boolean)
  • :last_updated (Time)
  • :model (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.

  • :policy_uuid (String)
  • :search (String) —

    A search term.

Returns:



1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 1630

def policies_event_matcher_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_event_matcher_list ...'
  end
  allowable_values = ["authorize_application", "configuration_error", "configuration_warning", "custom_", "email_sent", "export_ready", "flow_execution", "impersonation_ended", "impersonation_started", "invitation_used", "login", "login_failed", "logout", "model_created", "model_deleted", "model_updated", "password_set", "policy_exception", "policy_execution", "property_mapping_exception", "review_attested", "review_completed", "review_initiated", "review_overdue", "secret_rotate", "secret_view", "source_linked", "suspicious_request", "system_exception", "system_task_exception", "system_task_execution", "update_available", "user_write"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/policies/event_matcher/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'app'] = opts[:'app'] if !opts[:'app'].nil?
  query_params[:'client_ip'] = opts[:'client_ip'] if !opts[:'client_ip'].nil?
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'execution_logging'] = opts[:'execution_logging'] if !opts[:'execution_logging'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].nil?
  query_params[:'model'] = opts[:'model'] if !opts[:'model'].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[:'policy_uuid'] = opts[:'policy_uuid'] if !opts[:'policy_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] || 'PaginatedEventMatcherPolicyList'

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

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

#policies_event_matcher_partial_update(policy_uuid, opts = {}) ⇒ EventMatcherPolicy

Event Matcher Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Options Hash (opts):

Returns:



1696
1697
1698
1699
 
# File 'lib/authentik/api/api/policies_api.rb', line 1696

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

#policies_event_matcher_partial_update_with_http_info(policy_uuid, opts = {}) ⇒ Array<(EventMatcherPolicy, Integer, Hash)>

Event Matcher Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EventMatcherPolicy data, response status code and response headers



1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 1706

def policies_event_matcher_partial_update_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_event_matcher_partial_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_event_matcher_partial_update"
  end
  # resource path
  local_var_path = '/policies/event_matcher/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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_event_matcher_policy_request'])

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

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

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

#policies_event_matcher_retrieve(policy_uuid, opts = {}) ⇒ EventMatcherPolicy

Event Matcher Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Returns:



1763
1764
1765
1766
 
# File 'lib/authentik/api/api/policies_api.rb', line 1763

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

#policies_event_matcher_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(EventMatcherPolicy, Integer, Hash)>

Event Matcher Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Returns:

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

    EventMatcherPolicy data, response status code and response headers



1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 1772

def policies_event_matcher_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_event_matcher_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_event_matcher_retrieve"
  end
  # resource path
  local_var_path = '/policies/event_matcher/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'EventMatcherPolicy'

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

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

#policies_event_matcher_update(policy_uuid, event_matcher_policy_request, opts = {}) ⇒ EventMatcherPolicy

Event Matcher Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Returns:



1825
1826
1827
1828
 
# File 'lib/authentik/api/api/policies_api.rb', line 1825

def policies_event_matcher_update(policy_uuid, event_matcher_policy_request, opts = {})
  data, _status_code, _headers = policies_event_matcher_update_with_http_info(policy_uuid, event_matcher_policy_request, opts)
  data
end

#policies_event_matcher_update_with_http_info(policy_uuid, event_matcher_policy_request, opts = {}) ⇒ Array<(EventMatcherPolicy, Integer, Hash)>

Event Matcher Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Returns:

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

    EventMatcherPolicy data, response status code and response headers



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 1835

def policies_event_matcher_update_with_http_info(policy_uuid, event_matcher_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_event_matcher_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_event_matcher_update"
  end
  # verify the required parameter 'event_matcher_policy_request' is set
  if @api_client.config.client_side_validation && event_matcher_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'event_matcher_policy_request' when calling PoliciesApi.policies_event_matcher_update"
  end
  # resource path
  local_var_path = '/policies/event_matcher/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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(event_matcher_policy_request)

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

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

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

#policies_event_matcher_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Returns:



1896
1897
1898
1899
 
# File 'lib/authentik/api/api/policies_api.rb', line 1896

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

#policies_event_matcher_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Event Matcher Policy.

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

    the optional parameters

Returns:

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

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



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'lib/authentik/api/api/policies_api.rb', line 1905

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

#policies_expression_create(expression_policy_request, opts = {}) ⇒ ExpressionPolicy

Source Viewset

Parameters:

Returns:



1957
1958
1959
1960
 
# File 'lib/authentik/api/api/policies_api.rb', line 1957

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

#policies_expression_create_with_http_info(expression_policy_request, opts = {}) ⇒ Array<(ExpressionPolicy, Integer, Hash)>

Source Viewset

Parameters:

Returns:

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

    ExpressionPolicy data, response status code and response headers



1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 1966

def policies_expression_create_with_http_info(expression_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_expression_create ...'
  end
  # verify the required parameter 'expression_policy_request' is set
  if @api_client.config.client_side_validation && expression_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'expression_policy_request' when calling PoliciesApi.policies_expression_create"
  end
  # resource path
  local_var_path = '/policies/expression/'

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

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

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

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

#policies_expression_destroy(policy_uuid, opts = {}) ⇒ nil

Source Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Returns:

  • (nil) 


2023
2024
2025
2026
 
# File 'lib/authentik/api/api/policies_api.rb', line 2023

def policies_expression_destroy(policy_uuid, opts = {})
  policies_expression_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

Source Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
 
# File 'lib/authentik/api/api/policies_api.rb', line 2032

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

#policies_expression_list(opts = {}) ⇒ PaginatedExpressionPolicyList

Source Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created (Time)
  • :execution_logging (Boolean)
  • :expression (String)
  • :last_updated (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.

  • :policy_uuid (String)
  • :search (String) —

    A search term.

Returns:



2093
2094
2095
2096
 
# File 'lib/authentik/api/api/policies_api.rb', line 2093

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

#policies_expression_list_with_http_info(opts = {}) ⇒ Array<(PaginatedExpressionPolicyList, Integer, Hash)>

Source Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created (Time)
  • :execution_logging (Boolean)
  • :expression (String)
  • :last_updated (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.

  • :policy_uuid (String)
  • :search (String) —

    A search term.

Returns:



2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
 
# File 'lib/authentik/api/api/policies_api.rb', line 2111

def policies_expression_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_expression_list ...'
  end
  # resource path
  local_var_path = '/policies/expression/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'execution_logging'] = opts[:'execution_logging'] if !opts[:'execution_logging'].nil?
  query_params[:'expression'] = opts[:'expression'] if !opts[:'expression'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].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[:'policy_uuid'] = opts[:'policy_uuid'] if !opts[:'policy_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] || 'PaginatedExpressionPolicyList'

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

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

#policies_expression_partial_update(policy_uuid, opts = {}) ⇒ ExpressionPolicy

Source Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Options Hash (opts):

Returns:



2170
2171
2172
2173
 
# File 'lib/authentik/api/api/policies_api.rb', line 2170

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

#policies_expression_partial_update_with_http_info(policy_uuid, opts = {}) ⇒ Array<(ExpressionPolicy, Integer, Hash)>

Source Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ExpressionPolicy data, response status code and response headers



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
 
# File 'lib/authentik/api/api/policies_api.rb', line 2180

def policies_expression_partial_update_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_expression_partial_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_expression_partial_update"
  end
  # resource path
  local_var_path = '/policies/expression/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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_expression_policy_request'])

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

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

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

#policies_expression_retrieve(policy_uuid, opts = {}) ⇒ ExpressionPolicy

Source Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Returns:



2237
2238
2239
2240
 
# File 'lib/authentik/api/api/policies_api.rb', line 2237

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

#policies_expression_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(ExpressionPolicy, Integer, Hash)>

Source Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Returns:

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

    ExpressionPolicy data, response status code and response headers



2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
 
# File 'lib/authentik/api/api/policies_api.rb', line 2246

def policies_expression_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_expression_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_expression_retrieve"
  end
  # resource path
  local_var_path = '/policies/expression/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'ExpressionPolicy'

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

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

#policies_expression_update(policy_uuid, expression_policy_request, opts = {}) ⇒ ExpressionPolicy

Source Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Returns:



2299
2300
2301
2302
 
# File 'lib/authentik/api/api/policies_api.rb', line 2299

def policies_expression_update(policy_uuid, expression_policy_request, opts = {})
  data, _status_code, _headers = policies_expression_update_with_http_info(policy_uuid, expression_policy_request, opts)
  data
end

#policies_expression_update_with_http_info(policy_uuid, expression_policy_request, opts = {}) ⇒ Array<(ExpressionPolicy, Integer, Hash)>

Source Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Returns:

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

    ExpressionPolicy data, response status code and response headers



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
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
 
# File 'lib/authentik/api/api/policies_api.rb', line 2309

def policies_expression_update_with_http_info(policy_uuid, expression_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_expression_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_expression_update"
  end
  # verify the required parameter 'expression_policy_request' is set
  if @api_client.config.client_side_validation && expression_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'expression_policy_request' when calling PoliciesApi.policies_expression_update"
  end
  # resource path
  local_var_path = '/policies/expression/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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(expression_policy_request)

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

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

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

#policies_expression_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Returns:



2370
2371
2372
2373
 
# File 'lib/authentik/api/api/policies_api.rb', line 2370

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

#policies_expression_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Expression Policy.

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

    the optional parameters

Returns:

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

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



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
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
 
# File 'lib/authentik/api/api/policies_api.rb', line 2379

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

#policies_geoip_create(geo_ip_policy_request, opts = {}) ⇒ GeoIPPolicy

GeoIP Viewset

Parameters:

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

    the optional parameters

Returns:



2431
2432
2433
2434
 
# File 'lib/authentik/api/api/policies_api.rb', line 2431

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

#policies_geoip_create_with_http_info(geo_ip_policy_request, opts = {}) ⇒ Array<(GeoIPPolicy, Integer, Hash)>

GeoIP Viewset

Parameters:

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

    the optional parameters

Returns:

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

    GeoIPPolicy data, response status code and response headers



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
2485
2486
2487
2488
2489
2490
2491
 
# File 'lib/authentik/api/api/policies_api.rb', line 2440

def policies_geoip_create_with_http_info(geo_ip_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_geoip_create ...'
  end
  # verify the required parameter 'geo_ip_policy_request' is set
  if @api_client.config.client_side_validation && geo_ip_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'geo_ip_policy_request' when calling PoliciesApi.policies_geoip_create"
  end
  # resource path
  local_var_path = '/policies/geoip/'

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

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

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

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

#policies_geoip_destroy(policy_uuid, opts = {}) ⇒ nil

GeoIP Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Returns:

  • (nil) 


2497
2498
2499
2500
 
# File 'lib/authentik/api/api/policies_api.rb', line 2497

def policies_geoip_destroy(policy_uuid, opts = {})
  policies_geoip_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

GeoIP Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
2546
2547
2548
2549
2550
2551
2552
 
# File 'lib/authentik/api/api/policies_api.rb', line 2506

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

#policies_geoip_iso3166_list(opts = {}) ⇒ Array<DetailedCountry>

Get all countries in ISO-3166-1

Parameters:

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

    the optional parameters

Returns:



2557
2558
2559
2560
 
# File 'lib/authentik/api/api/policies_api.rb', line 2557

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

#policies_geoip_iso3166_list_with_http_info(opts = {}) ⇒ Array<(Array<DetailedCountry>, Integer, Hash)>

Get all countries in ISO-3166-1

Parameters:

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

    the optional parameters

Returns:

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

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



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

def policies_geoip_iso3166_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_geoip_iso3166_list ...'
  end
  # resource path
  local_var_path = '/policies/geoip_iso3166/'

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

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

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

#policies_geoip_list(opts = {}) ⇒ PaginatedGeoIPPolicyList

GeoIP Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:



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

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

#policies_geoip_list_with_http_info(opts = {}) ⇒ Array<(PaginatedGeoIPPolicyList, Integer, Hash)>

GeoIP Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:

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

    PaginatedGeoIPPolicyList data, response status code and response headers



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
2673
2674
2675
2676
2677
 
# File 'lib/authentik/api/api/policies_api.rb', line 2630

def policies_geoip_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_geoip_list ...'
  end
  # resource path
  local_var_path = '/policies/geoip/'

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

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

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

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

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

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

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

#policies_geoip_partial_update(policy_uuid, opts = {}) ⇒ GeoIPPolicy

GeoIP Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Options Hash (opts):

Returns:



2684
2685
2686
2687
 
# File 'lib/authentik/api/api/policies_api.rb', line 2684

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

#policies_geoip_partial_update_with_http_info(policy_uuid, opts = {}) ⇒ Array<(GeoIPPolicy, Integer, Hash)>

GeoIP Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GeoIPPolicy data, response status code and response headers



2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
 
# File 'lib/authentik/api/api/policies_api.rb', line 2694

def policies_geoip_partial_update_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_geoip_partial_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_geoip_partial_update"
  end
  # resource path
  local_var_path = '/policies/geoip/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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_geo_ip_policy_request'])

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

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

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

#policies_geoip_retrieve(policy_uuid, opts = {}) ⇒ GeoIPPolicy

GeoIP Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Returns:



2751
2752
2753
2754
 
# File 'lib/authentik/api/api/policies_api.rb', line 2751

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

#policies_geoip_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(GeoIPPolicy, Integer, Hash)>

GeoIP Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Returns:

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

    GeoIPPolicy data, response status code and response headers



2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
 
# File 'lib/authentik/api/api/policies_api.rb', line 2760

def policies_geoip_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_geoip_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_geoip_retrieve"
  end
  # resource path
  local_var_path = '/policies/geoip/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'GeoIPPolicy'

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

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

#policies_geoip_update(policy_uuid, geo_ip_policy_request, opts = {}) ⇒ GeoIPPolicy

GeoIP Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Returns:



2813
2814
2815
2816
 
# File 'lib/authentik/api/api/policies_api.rb', line 2813

def policies_geoip_update(policy_uuid, geo_ip_policy_request, opts = {})
  data, _status_code, _headers = policies_geoip_update_with_http_info(policy_uuid, geo_ip_policy_request, opts)
  data
end

#policies_geoip_update_with_http_info(policy_uuid, geo_ip_policy_request, opts = {}) ⇒ Array<(GeoIPPolicy, Integer, Hash)>

GeoIP Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Returns:

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

    GeoIPPolicy data, response status code and response headers



2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
 
# File 'lib/authentik/api/api/policies_api.rb', line 2823

def policies_geoip_update_with_http_info(policy_uuid, geo_ip_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_geoip_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_geoip_update"
  end
  # verify the required parameter 'geo_ip_policy_request' is set
  if @api_client.config.client_side_validation && geo_ip_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'geo_ip_policy_request' when calling PoliciesApi.policies_geoip_update"
  end
  # resource path
  local_var_path = '/policies/geoip/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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(geo_ip_policy_request)

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

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

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

#policies_geoip_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Returns:



2884
2885
2886
2887
 
# File 'lib/authentik/api/api/policies_api.rb', line 2884

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

#policies_geoip_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this GeoIP Policy.

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

    the optional parameters

Returns:

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

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



2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 2893

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

#policies_password_create(password_policy_request, opts = {}) ⇒ PasswordPolicy

Password Policy Viewset

Parameters:

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

    the optional parameters

Returns:



2945
2946
2947
2948
 
# File 'lib/authentik/api/api/policies_api.rb', line 2945

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

#policies_password_create_with_http_info(password_policy_request, opts = {}) ⇒ Array<(PasswordPolicy, Integer, Hash)>

Password Policy Viewset

Parameters:

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

    the optional parameters

Returns:

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

    PasswordPolicy data, response status code and response headers



2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 2954

def policies_password_create_with_http_info(password_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_create ...'
  end
  # verify the required parameter 'password_policy_request' is set
  if @api_client.config.client_side_validation && password_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'password_policy_request' when calling PoliciesApi.policies_password_create"
  end
  # resource path
  local_var_path = '/policies/password/'

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

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

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

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

#policies_password_destroy(policy_uuid, opts = {}) ⇒ nil

Password Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Returns:

  • (nil) 


3011
3012
3013
3014
 
# File 'lib/authentik/api/api/policies_api.rb', line 3011

def policies_password_destroy(policy_uuid, opts = {})
  policies_password_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

Password Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
 
# File 'lib/authentik/api/api/policies_api.rb', line 3020

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

#policies_password_expiry_create(password_expiry_policy_request, opts = {}) ⇒ PasswordExpiryPolicy

Password Expiry Viewset

Parameters:

Returns:



3072
3073
3074
3075
 
# File 'lib/authentik/api/api/policies_api.rb', line 3072

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

#policies_password_expiry_create_with_http_info(password_expiry_policy_request, opts = {}) ⇒ Array<(PasswordExpiryPolicy, Integer, Hash)>

Password Expiry Viewset

Parameters:

Returns:

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

    PasswordExpiryPolicy data, response status code and response headers



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
 
# File 'lib/authentik/api/api/policies_api.rb', line 3081

def policies_password_expiry_create_with_http_info(password_expiry_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_expiry_create ...'
  end
  # verify the required parameter 'password_expiry_policy_request' is set
  if @api_client.config.client_side_validation && password_expiry_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'password_expiry_policy_request' when calling PoliciesApi.policies_password_expiry_create"
  end
  # resource path
  local_var_path = '/policies/password_expiry/'

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

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

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

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

#policies_password_expiry_destroy(policy_uuid, opts = {}) ⇒ nil

Password Expiry Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Returns:

  • (nil) 


3138
3139
3140
3141
 
# File 'lib/authentik/api/api/policies_api.rb', line 3138

def policies_password_expiry_destroy(policy_uuid, opts = {})
  policies_password_expiry_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

Password Expiry Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
 
# File 'lib/authentik/api/api/policies_api.rb', line 3147

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

#policies_password_expiry_list(opts = {}) ⇒ PaginatedPasswordExpiryPolicyList

Password Expiry Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created (Time)
  • :days (Integer)
  • :deny_only (Boolean)
  • :execution_logging (Boolean)
  • :last_updated (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.

  • :policy_uuid (String)
  • :search (String) —

    A search term.

Returns:



3209
3210
3211
3212
 
# File 'lib/authentik/api/api/policies_api.rb', line 3209

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

#policies_password_expiry_list_with_http_info(opts = {}) ⇒ Array<(PaginatedPasswordExpiryPolicyList, Integer, Hash)>

Password Expiry Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created (Time)
  • :days (Integer)
  • :deny_only (Boolean)
  • :execution_logging (Boolean)
  • :last_updated (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.

  • :policy_uuid (String)
  • :search (String) —

    A search term.

Returns:



3228
3229
3230
3231
3232
3233
3234
3235
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 3228

def policies_password_expiry_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_expiry_list ...'
  end
  # resource path
  local_var_path = '/policies/password_expiry/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
  query_params[:'deny_only'] = opts[:'deny_only'] if !opts[:'deny_only'].nil?
  query_params[:'execution_logging'] = opts[:'execution_logging'] if !opts[:'execution_logging'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].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[:'policy_uuid'] = opts[:'policy_uuid'] if !opts[:'policy_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] || 'PaginatedPasswordExpiryPolicyList'

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

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

#policies_password_expiry_partial_update(policy_uuid, opts = {}) ⇒ PasswordExpiryPolicy

Password Expiry Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Options Hash (opts):

Returns:



3288
3289
3290
3291
 
# File 'lib/authentik/api/api/policies_api.rb', line 3288

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

#policies_password_expiry_partial_update_with_http_info(policy_uuid, opts = {}) ⇒ Array<(PasswordExpiryPolicy, Integer, Hash)>

Password Expiry Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PasswordExpiryPolicy data, response status code and response headers



3298
3299
3300
3301
3302
3303
3304
3305
3306
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 3298

def policies_password_expiry_partial_update_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_expiry_partial_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_password_expiry_partial_update"
  end
  # resource path
  local_var_path = '/policies/password_expiry/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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_password_expiry_policy_request'])

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

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

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

#policies_password_expiry_retrieve(policy_uuid, opts = {}) ⇒ PasswordExpiryPolicy

Password Expiry Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Returns:



3355
3356
3357
3358
 
# File 'lib/authentik/api/api/policies_api.rb', line 3355

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

#policies_password_expiry_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(PasswordExpiryPolicy, Integer, Hash)>

Password Expiry Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Returns:

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

    PasswordExpiryPolicy data, response status code and response headers



3364
3365
3366
3367
3368
3369
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 3364

def policies_password_expiry_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_expiry_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_password_expiry_retrieve"
  end
  # resource path
  local_var_path = '/policies/password_expiry/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'PasswordExpiryPolicy'

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

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

#policies_password_expiry_update(policy_uuid, password_expiry_policy_request, opts = {}) ⇒ PasswordExpiryPolicy

Password Expiry Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Returns:



3417
3418
3419
3420
 
# File 'lib/authentik/api/api/policies_api.rb', line 3417

def policies_password_expiry_update(policy_uuid, password_expiry_policy_request, opts = {})
  data, _status_code, _headers = policies_password_expiry_update_with_http_info(policy_uuid, password_expiry_policy_request, opts)
  data
end

#policies_password_expiry_update_with_http_info(policy_uuid, password_expiry_policy_request, opts = {}) ⇒ Array<(PasswordExpiryPolicy, Integer, Hash)>

Password Expiry Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Returns:

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

    PasswordExpiryPolicy data, response status code and response headers



3427
3428
3429
3430
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
3478
3479
3480
3481
3482
 
# File 'lib/authentik/api/api/policies_api.rb', line 3427

def policies_password_expiry_update_with_http_info(policy_uuid, password_expiry_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_expiry_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_password_expiry_update"
  end
  # verify the required parameter 'password_expiry_policy_request' is set
  if @api_client.config.client_side_validation && password_expiry_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'password_expiry_policy_request' when calling PoliciesApi.policies_password_expiry_update"
  end
  # resource path
  local_var_path = '/policies/password_expiry/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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(password_expiry_policy_request)

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

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

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

#policies_password_expiry_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Returns:



3488
3489
3490
3491
 
# File 'lib/authentik/api/api/policies_api.rb', line 3488

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

#policies_password_expiry_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Expiry Policy.

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

    the optional parameters

Returns:

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

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



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
3540
3541
3542
3543
 
# File 'lib/authentik/api/api/policies_api.rb', line 3497

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

#policies_password_list(opts = {}) ⇒ PaginatedPasswordPolicyList

Password Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :amount_digits (Integer)
  • :amount_lowercase (Integer)
  • :amount_symbols (Integer)
  • :amount_uppercase (Integer)
  • :check_have_i_been_pwned (Boolean)
  • :check_static_rules (Boolean)
  • :check_zxcvbn (Boolean)
  • :created (Time)
  • :error_message (String)
  • :execution_logging (Boolean)
  • :hibp_allowed_count (Integer)
  • :last_updated (Time)
  • :length_min (Integer)
  • :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.

  • :password_field (String)
  • :policy_uuid (String)
  • :search (String) —

    A search term.

  • :symbol_charset (String)
  • :zxcvbn_score_threshold (Integer)

Returns:



3570
3571
3572
3573
 
# File 'lib/authentik/api/api/policies_api.rb', line 3570

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

#policies_password_list_with_http_info(opts = {}) ⇒ Array<(PaginatedPasswordPolicyList, Integer, Hash)>

Password Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :amount_digits (Integer)
  • :amount_lowercase (Integer)
  • :amount_symbols (Integer)
  • :amount_uppercase (Integer)
  • :check_have_i_been_pwned (Boolean)
  • :check_static_rules (Boolean)
  • :check_zxcvbn (Boolean)
  • :created (Time)
  • :error_message (String)
  • :execution_logging (Boolean)
  • :hibp_allowed_count (Integer)
  • :last_updated (Time)
  • :length_min (Integer)
  • :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.

  • :password_field (String)
  • :policy_uuid (String)
  • :search (String) —

    A search term.

  • :symbol_charset (String)
  • :zxcvbn_score_threshold (Integer)

Returns:

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

    PaginatedPasswordPolicyList data, response status code and response headers



3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 3600

def policies_password_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_list ...'
  end
  # resource path
  local_var_path = '/policies/password/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'amount_digits'] = opts[:'amount_digits'] if !opts[:'amount_digits'].nil?
  query_params[:'amount_lowercase'] = opts[:'amount_lowercase'] if !opts[:'amount_lowercase'].nil?
  query_params[:'amount_symbols'] = opts[:'amount_symbols'] if !opts[:'amount_symbols'].nil?
  query_params[:'amount_uppercase'] = opts[:'amount_uppercase'] if !opts[:'amount_uppercase'].nil?
  query_params[:'check_have_i_been_pwned'] = opts[:'check_have_i_been_pwned'] if !opts[:'check_have_i_been_pwned'].nil?
  query_params[:'check_static_rules'] = opts[:'check_static_rules'] if !opts[:'check_static_rules'].nil?
  query_params[:'check_zxcvbn'] = opts[:'check_zxcvbn'] if !opts[:'check_zxcvbn'].nil?
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'error_message'] = opts[:'error_message'] if !opts[:'error_message'].nil?
  query_params[:'execution_logging'] = opts[:'execution_logging'] if !opts[:'execution_logging'].nil?
  query_params[:'hibp_allowed_count'] = opts[:'hibp_allowed_count'] if !opts[:'hibp_allowed_count'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].nil?
  query_params[:'length_min'] = opts[:'length_min'] if !opts[:'length_min'].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[:'password_field'] = opts[:'password_field'] if !opts[:'password_field'].nil?
  query_params[:'policy_uuid'] = opts[:'policy_uuid'] if !opts[:'policy_uuid'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'symbol_charset'] = opts[:'symbol_charset'] if !opts[:'symbol_charset'].nil?
  query_params[:'zxcvbn_score_threshold'] = opts[:'zxcvbn_score_threshold'] if !opts[:'zxcvbn_score_threshold'].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] || 'PaginatedPasswordPolicyList'

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

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

#policies_password_partial_update(policy_uuid, opts = {}) ⇒ PasswordPolicy

Password Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Options Hash (opts):

Returns:



3671
3672
3673
3674
 
# File 'lib/authentik/api/api/policies_api.rb', line 3671

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

#policies_password_partial_update_with_http_info(policy_uuid, opts = {}) ⇒ Array<(PasswordPolicy, Integer, Hash)>

Password Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PasswordPolicy data, response status code and response headers



3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
 
# File 'lib/authentik/api/api/policies_api.rb', line 3681

def policies_password_partial_update_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_partial_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_password_partial_update"
  end
  # resource path
  local_var_path = '/policies/password/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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_password_policy_request'])

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

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

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

#policies_password_retrieve(policy_uuid, opts = {}) ⇒ PasswordPolicy

Password Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Returns:



3738
3739
3740
3741
 
# File 'lib/authentik/api/api/policies_api.rb', line 3738

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

#policies_password_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(PasswordPolicy, Integer, Hash)>

Password Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Returns:

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

    PasswordPolicy data, response status code and response headers



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

def policies_password_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_password_retrieve"
  end
  # resource path
  local_var_path = '/policies/password/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'PasswordPolicy'

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

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

#policies_password_update(policy_uuid, password_policy_request, opts = {}) ⇒ PasswordPolicy

Password Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Returns:



3800
3801
3802
3803
 
# File 'lib/authentik/api/api/policies_api.rb', line 3800

def policies_password_update(policy_uuid, password_policy_request, opts = {})
  data, _status_code, _headers = policies_password_update_with_http_info(policy_uuid, password_policy_request, opts)
  data
end

#policies_password_update_with_http_info(policy_uuid, password_policy_request, opts = {}) ⇒ Array<(PasswordPolicy, Integer, Hash)>

Password Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Returns:

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

    PasswordPolicy data, response status code and response headers



3810
3811
3812
3813
3814
3815
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
 
# File 'lib/authentik/api/api/policies_api.rb', line 3810

def policies_password_update_with_http_info(policy_uuid, password_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_password_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_password_update"
  end
  # verify the required parameter 'password_policy_request' is set
  if @api_client.config.client_side_validation && password_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'password_policy_request' when calling PoliciesApi.policies_password_update"
  end
  # resource path
  local_var_path = '/policies/password/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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(password_policy_request)

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

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

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

#policies_password_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Returns:



3871
3872
3873
3874
 
# File 'lib/authentik/api/api/policies_api.rb', line 3871

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

#policies_password_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Policy.

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

    the optional parameters

Returns:

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

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



3880
3881
3882
3883
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/policies_api.rb', line 3880

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

#policies_reputation_create(reputation_policy_request, opts = {}) ⇒ ReputationPolicy

Reputation Policy Viewset

Parameters:

Returns:



3932
3933
3934
3935
 
# File 'lib/authentik/api/api/policies_api.rb', line 3932

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

#policies_reputation_create_with_http_info(reputation_policy_request, opts = {}) ⇒ Array<(ReputationPolicy, Integer, Hash)>

Reputation Policy Viewset

Parameters:

Returns:

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

    ReputationPolicy data, response status code and response headers



3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'lib/authentik/api/api/policies_api.rb', line 3941

def policies_reputation_create_with_http_info(reputation_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_reputation_create ...'
  end
  # verify the required parameter 'reputation_policy_request' is set
  if @api_client.config.client_side_validation && reputation_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'reputation_policy_request' when calling PoliciesApi.policies_reputation_create"
  end
  # resource path
  local_var_path = '/policies/reputation/'

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

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

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

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

#policies_reputation_destroy(policy_uuid, opts = {}) ⇒ nil

Reputation Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Returns:

  • (nil) 


3998
3999
4000
4001
 
# File 'lib/authentik/api/api/policies_api.rb', line 3998

def policies_reputation_destroy(policy_uuid, opts = {})
  policies_reputation_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

Reputation Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#policies_reputation_list(opts = {}) ⇒ PaginatedReputationPolicyList

Reputation Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :check_ip (Boolean)
  • :check_username (Boolean)
  • :created (Time)
  • :execution_logging (Boolean)
  • :last_updated (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.

  • :policy_uuid (String)
  • :search (String) —

    A search term.

  • :threshold (Integer)

Returns:



4070
4071
4072
4073
 
# File 'lib/authentik/api/api/policies_api.rb', line 4070

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

#policies_reputation_list_with_http_info(opts = {}) ⇒ Array<(PaginatedReputationPolicyList, Integer, Hash)>

Reputation Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :check_ip (Boolean)
  • :check_username (Boolean)
  • :created (Time)
  • :execution_logging (Boolean)
  • :last_updated (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.

  • :policy_uuid (String)
  • :search (String) —

    A search term.

  • :threshold (Integer)

Returns:



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
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
 
# File 'lib/authentik/api/api/policies_api.rb', line 4090

def policies_reputation_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_reputation_list ...'
  end
  # resource path
  local_var_path = '/policies/reputation/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'check_ip'] = opts[:'check_ip'] if !opts[:'check_ip'].nil?
  query_params[:'check_username'] = opts[:'check_username'] if !opts[:'check_username'].nil?
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'execution_logging'] = opts[:'execution_logging'] if !opts[:'execution_logging'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].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[:'policy_uuid'] = opts[:'policy_uuid'] if !opts[:'policy_uuid'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'threshold'] = opts[:'threshold'] if !opts[:'threshold'].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] || 'PaginatedReputationPolicyList'

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

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

#policies_reputation_partial_update(policy_uuid, opts = {}) ⇒ ReputationPolicy

Reputation Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Options Hash (opts):

Returns:



4151
4152
4153
4154
 
# File 'lib/authentik/api/api/policies_api.rb', line 4151

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

#policies_reputation_partial_update_with_http_info(policy_uuid, opts = {}) ⇒ Array<(ReputationPolicy, Integer, Hash)>

Reputation Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ReputationPolicy data, response status code and response headers



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
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
 
# File 'lib/authentik/api/api/policies_api.rb', line 4161

def policies_reputation_partial_update_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_reputation_partial_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_reputation_partial_update"
  end
  # resource path
  local_var_path = '/policies/reputation/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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_reputation_policy_request'])

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

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

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

#policies_reputation_retrieve(policy_uuid, opts = {}) ⇒ ReputationPolicy

Reputation Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Returns:



4218
4219
4220
4221
 
# File 'lib/authentik/api/api/policies_api.rb', line 4218

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

#policies_reputation_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(ReputationPolicy, Integer, Hash)>

Reputation Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Returns:

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

    ReputationPolicy data, response status code and response headers



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
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
 
# File 'lib/authentik/api/api/policies_api.rb', line 4227

def policies_reputation_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_reputation_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_reputation_retrieve"
  end
  # resource path
  local_var_path = '/policies/reputation/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'ReputationPolicy'

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

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

#policies_reputation_scores_destroy(reputation_uuid, opts = {}) ⇒ nil

Reputation Viewset

Parameters:

  • reputation_uuid (String) —

    A UUID string identifying this Reputation Score.

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

    the optional parameters

Returns:

  • (nil) 


4279
4280
4281
4282
 
# File 'lib/authentik/api/api/policies_api.rb', line 4279

def policies_reputation_scores_destroy(reputation_uuid, opts = {})
  policies_reputation_scores_destroy_with_http_info(reputation_uuid, opts)
  nil
end

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

Reputation Viewset

Parameters:

  • reputation_uuid (String) —

    A UUID string identifying this Reputation Score.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
 
# File 'lib/authentik/api/api/policies_api.rb', line 4288

def policies_reputation_scores_destroy_with_http_info(reputation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_reputation_scores_destroy ...'
  end
  # verify the required parameter 'reputation_uuid' is set
  if @api_client.config.client_side_validation && reputation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'reputation_uuid' when calling PoliciesApi.policies_reputation_scores_destroy"
  end
  # resource path
  local_var_path = '/policies/reputation/scores/{reputation_uuid}/'.sub('{reputation_uuid}', CGI.escape(reputation_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 => :"PoliciesApi.policies_reputation_scores_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: PoliciesApi#policies_reputation_scores_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#policies_reputation_scores_list(opts = {}) ⇒ PaginatedReputationList

Reputation Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :identifier (String)
  • :identifier_in (Array<String>) —

    Multiple values may be separated by commas.

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

  • :score (Integer)
  • :search (String) —

    A search term.

Returns:



4347
4348
4349
4350
 
# File 'lib/authentik/api/api/policies_api.rb', line 4347

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

#policies_reputation_scores_list_with_http_info(opts = {}) ⇒ Array<(PaginatedReputationList, Integer, Hash)>

Reputation Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :identifier (String)
  • :identifier_in (Array<String>) —

    Multiple values may be separated by commas.

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

  • :score (Integer)
  • :search (String) —

    A search term.

Returns:

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

    PaginatedReputationList data, response status code and response headers



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
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
 
# File 'lib/authentik/api/api/policies_api.rb', line 4363

def policies_reputation_scores_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_reputation_scores_list ...'
  end
  # resource path
  local_var_path = '/policies/reputation/scores/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'identifier_in'] = @api_client.build_collection_param(opts[:'identifier_in'], :csv) if !opts[:'identifier_in'].nil?
  query_params[:'ip'] = opts[:'ip'] if !opts[:'ip'].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[:'score'] = opts[:'score'] if !opts[:'score'].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] || 'PaginatedReputationList'

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

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

#policies_reputation_scores_retrieve(reputation_uuid, opts = {}) ⇒ Reputation

Reputation Viewset

Parameters:

  • reputation_uuid (String) —

    A UUID string identifying this Reputation Score.

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

    the optional parameters

Returns:



4419
4420
4421
4422
 
# File 'lib/authentik/api/api/policies_api.rb', line 4419

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

#policies_reputation_scores_retrieve_with_http_info(reputation_uuid, opts = {}) ⇒ Array<(Reputation, Integer, Hash)>

Reputation Viewset

Parameters:

  • reputation_uuid (String) —

    A UUID string identifying this Reputation Score.

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

    the optional parameters

Returns:

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

    Reputation data, response status code and response headers



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
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
 
# File 'lib/authentik/api/api/policies_api.rb', line 4428

def policies_reputation_scores_retrieve_with_http_info(reputation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_reputation_scores_retrieve ...'
  end
  # verify the required parameter 'reputation_uuid' is set
  if @api_client.config.client_side_validation && reputation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'reputation_uuid' when calling PoliciesApi.policies_reputation_scores_retrieve"
  end
  # resource path
  local_var_path = '/policies/reputation/scores/{reputation_uuid}/'.sub('{reputation_uuid}', CGI.escape(reputation_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] || 'Reputation'

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

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

#policies_reputation_scores_used_by_list(reputation_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • reputation_uuid (String) —

    A UUID string identifying this Reputation Score.

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

    the optional parameters

Returns:



4480
4481
4482
4483
 
# File 'lib/authentik/api/api/policies_api.rb', line 4480

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

#policies_reputation_scores_used_by_list_with_http_info(reputation_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • reputation_uuid (String) —

    A UUID string identifying this Reputation Score.

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

    the optional parameters

Returns:

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

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



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
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
 
# File 'lib/authentik/api/api/policies_api.rb', line 4489

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

#policies_reputation_update(policy_uuid, reputation_policy_request, opts = {}) ⇒ ReputationPolicy

Reputation Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Returns:



4542
4543
4544
4545
 
# File 'lib/authentik/api/api/policies_api.rb', line 4542

def policies_reputation_update(policy_uuid, reputation_policy_request, opts = {})
  data, _status_code, _headers = policies_reputation_update_with_http_info(policy_uuid, reputation_policy_request, opts)
  data
end

#policies_reputation_update_with_http_info(policy_uuid, reputation_policy_request, opts = {}) ⇒ Array<(ReputationPolicy, Integer, Hash)>

Reputation Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Returns:

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

    ReputationPolicy data, response status code and response headers



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
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
 
# File 'lib/authentik/api/api/policies_api.rb', line 4552

def policies_reputation_update_with_http_info(policy_uuid, reputation_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_reputation_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_reputation_update"
  end
  # verify the required parameter 'reputation_policy_request' is set
  if @api_client.config.client_side_validation && reputation_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'reputation_policy_request' when calling PoliciesApi.policies_reputation_update"
  end
  # resource path
  local_var_path = '/policies/reputation/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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(reputation_policy_request)

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

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

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

#policies_reputation_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Returns:



4613
4614
4615
4616
 
# File 'lib/authentik/api/api/policies_api.rb', line 4613

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

#policies_reputation_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Reputation Policy.

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

    the optional parameters

Returns:

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

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



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
4664
4665
4666
4667
4668
 
# File 'lib/authentik/api/api/policies_api.rb', line 4622

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

#policies_unique_password_create(unique_password_policy_request, opts = {}) ⇒ UniquePasswordPolicy

Password Uniqueness Policy Viewset

Parameters:

Returns:



4674
4675
4676
4677
 
# File 'lib/authentik/api/api/policies_api.rb', line 4674

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

#policies_unique_password_create_with_http_info(unique_password_policy_request, opts = {}) ⇒ Array<(UniquePasswordPolicy, Integer, Hash)>

Password Uniqueness Policy Viewset

Parameters:

Returns:

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

    UniquePasswordPolicy data, response status code and response headers



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

def policies_unique_password_create_with_http_info(unique_password_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_unique_password_create ...'
  end
  # verify the required parameter 'unique_password_policy_request' is set
  if @api_client.config.client_side_validation && unique_password_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'unique_password_policy_request' when calling PoliciesApi.policies_unique_password_create"
  end
  # resource path
  local_var_path = '/policies/unique_password/'

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

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

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

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

#policies_unique_password_destroy(policy_uuid, opts = {}) ⇒ nil

Password Uniqueness Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Returns:

  • (nil) 


4740
4741
4742
4743
 
# File 'lib/authentik/api/api/policies_api.rb', line 4740

def policies_unique_password_destroy(policy_uuid, opts = {})
  policies_unique_password_destroy_with_http_info(policy_uuid, opts)
  nil
end

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

Password Uniqueness Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#policies_unique_password_list(opts = {}) ⇒ PaginatedUniquePasswordPolicyList

Password Uniqueness Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created (Time)
  • :execution_logging (Boolean)
  • :last_updated (Time)
  • :name (String)
  • :num_historical_passwords (Integer)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :password_field (String)
  • :policy_uuid (String)
  • :search (String) —

    A search term.

Returns:



4811
4812
4813
4814
 
# File 'lib/authentik/api/api/policies_api.rb', line 4811

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

#policies_unique_password_list_with_http_info(opts = {}) ⇒ Array<(PaginatedUniquePasswordPolicyList, Integer, Hash)>

Password Uniqueness Policy Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created (Time)
  • :execution_logging (Boolean)
  • :last_updated (Time)
  • :name (String)
  • :num_historical_passwords (Integer)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :password_field (String)
  • :policy_uuid (String)
  • :search (String) —

    A search term.

Returns:



4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
 
# File 'lib/authentik/api/api/policies_api.rb', line 4830

def policies_unique_password_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_unique_password_list ...'
  end
  # resource path
  local_var_path = '/policies/unique_password/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'execution_logging'] = opts[:'execution_logging'] if !opts[:'execution_logging'].nil?
  query_params[:'last_updated'] = opts[:'last_updated'] if !opts[:'last_updated'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'num_historical_passwords'] = opts[:'num_historical_passwords'] if !opts[:'num_historical_passwords'].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[:'password_field'] = opts[:'password_field'] if !opts[:'password_field'].nil?
  query_params[:'policy_uuid'] = opts[:'policy_uuid'] if !opts[:'policy_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] || 'PaginatedUniquePasswordPolicyList'

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

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

#policies_unique_password_partial_update(policy_uuid, opts = {}) ⇒ UniquePasswordPolicy

Password Uniqueness Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Options Hash (opts):

Returns:



4890
4891
4892
4893
 
# File 'lib/authentik/api/api/policies_api.rb', line 4890

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

#policies_unique_password_partial_update_with_http_info(policy_uuid, opts = {}) ⇒ Array<(UniquePasswordPolicy, Integer, Hash)>

Password Uniqueness Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UniquePasswordPolicy data, response status code and response headers



4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
 
# File 'lib/authentik/api/api/policies_api.rb', line 4900

def policies_unique_password_partial_update_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_unique_password_partial_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_unique_password_partial_update"
  end
  # resource path
  local_var_path = '/policies/unique_password/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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_unique_password_policy_request'])

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

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

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

#policies_unique_password_retrieve(policy_uuid, opts = {}) ⇒ UniquePasswordPolicy

Password Uniqueness Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Returns:



4957
4958
4959
4960
 
# File 'lib/authentik/api/api/policies_api.rb', line 4957

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

#policies_unique_password_retrieve_with_http_info(policy_uuid, opts = {}) ⇒ Array<(UniquePasswordPolicy, Integer, Hash)>

Password Uniqueness Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Returns:

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

    UniquePasswordPolicy data, response status code and response headers



4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
 
# File 'lib/authentik/api/api/policies_api.rb', line 4966

def policies_unique_password_retrieve_with_http_info(policy_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_unique_password_retrieve ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_unique_password_retrieve"
  end
  # resource path
  local_var_path = '/policies/unique_password/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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] || 'UniquePasswordPolicy'

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

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

#policies_unique_password_update(policy_uuid, unique_password_policy_request, opts = {}) ⇒ UniquePasswordPolicy

Password Uniqueness Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Returns:



5019
5020
5021
5022
 
# File 'lib/authentik/api/api/policies_api.rb', line 5019

def policies_unique_password_update(policy_uuid, unique_password_policy_request, opts = {})
  data, _status_code, _headers = policies_unique_password_update_with_http_info(policy_uuid, unique_password_policy_request, opts)
  data
end

#policies_unique_password_update_with_http_info(policy_uuid, unique_password_policy_request, opts = {}) ⇒ Array<(UniquePasswordPolicy, Integer, Hash)>

Password Uniqueness Policy Viewset

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Returns:

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

    UniquePasswordPolicy data, response status code and response headers



5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
 
# File 'lib/authentik/api/api/policies_api.rb', line 5029

def policies_unique_password_update_with_http_info(policy_uuid, unique_password_policy_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PoliciesApi.policies_unique_password_update ...'
  end
  # verify the required parameter 'policy_uuid' is set
  if @api_client.config.client_side_validation && policy_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_uuid' when calling PoliciesApi.policies_unique_password_update"
  end
  # verify the required parameter 'unique_password_policy_request' is set
  if @api_client.config.client_side_validation && unique_password_policy_request.nil?
    fail ArgumentError, "Missing the required parameter 'unique_password_policy_request' when calling PoliciesApi.policies_unique_password_update"
  end
  # resource path
  local_var_path = '/policies/unique_password/{policy_uuid}/'.sub('{policy_uuid}', CGI.escape(policy_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(unique_password_policy_request)

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

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

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

#policies_unique_password_used_by_list(policy_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Returns:



5090
5091
5092
5093
 
# File 'lib/authentik/api/api/policies_api.rb', line 5090

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

#policies_unique_password_used_by_list_with_http_info(policy_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • policy_uuid (String) —

    A UUID string identifying this Password Uniqueness Policy.

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

    the optional parameters

Returns:

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

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



5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
 
# File 'lib/authentik/api/api/policies_api.rb', line 5099

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