Class: Authentik::Api::EventsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventsApi

Returns a new instance of EventsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Get all actions

Parameters:

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

    the optional parameters

Returns:



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

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

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

Get all actions

Parameters:

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

    the optional parameters

Returns:

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

    Array<TypeCreate> data, 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/events_api.rb', line 27

def events_events_actions_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_actions_list ...'
  end
  # resource path
  local_var_path = '/events/events/actions/'

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

#events_events_create(event_request, opts = {}) ⇒ Event

Event Read-Only Viewset

Parameters:

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

    the optional parameters

Returns:



75
76
77
78
 
# File 'lib/authentik/api/api/events_api.rb', line 75

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

#events_events_create_with_http_info(event_request, opts = {}) ⇒ Array<(Event, Integer, Hash)>

Event Read-Only Viewset

Parameters:

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

    the optional parameters

Returns:

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

    Event data, response status code and response headers



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
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/authentik/api/api/events_api.rb', line 84

def events_events_create_with_http_info(event_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_create ...'
  end
  # verify the required parameter 'event_request' is set
  if @api_client.config.client_side_validation && event_request.nil?
    fail ArgumentError, "Missing the required parameter 'event_request' when calling EventsApi.events_events_create"
  end
  # resource path
  local_var_path = '/events/events/'

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

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

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

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

#events_events_destroy(event_uuid, opts = {}) ⇒ nil

Event Read-Only Viewset

Parameters:

  • event_uuid (String) —

    A UUID string identifying this Event.

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

    the optional parameters

Returns:

  • (nil) 


141
142
143
144
 
# File 'lib/authentik/api/api/events_api.rb', line 141

def events_events_destroy(event_uuid, opts = {})
  events_events_destroy_with_http_info(event_uuid, opts)
  nil
end

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

Event Read-Only Viewset

Parameters:

  • event_uuid (String) —

    A UUID string identifying this Event.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/authentik/api/api/events_api.rb', line 150

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

#events_events_export_create(opts = {}) ⇒ DataExport

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String)
  • :actions (Array<String>)
  • :brand_name (String) —

    Brand name

  • :client_ip (String)
  • :context_authorized_app (String) —

    Context Authorized application

  • :context_model_app (String) —

    Context Model App

  • :context_model_name (String) —

    Context Model Name

  • :context_model_pk (String) —

    Context Model Primary Key

  • :ordering (String) —

    Which field to use when ordering the results.

  • :search (String) —

    A search term.

  • :username (String) —

    Username

Returns:



212
213
214
215
 
# File 'lib/authentik/api/api/events_api.rb', line 212

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

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

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String)
  • :actions (Array<String>)
  • :brand_name (String) —

    Brand name

  • :client_ip (String)
  • :context_authorized_app (String) —

    Context Authorized application

  • :context_model_app (String) —

    Context Model App

  • :context_model_name (String) —

    Context Model Name

  • :context_model_pk (String) —

    Context Model Primary Key

  • :ordering (String) —

    Which field to use when ordering the results.

  • :search (String) —

    A search term.

  • :username (String) —

    Username

Returns:

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

    DataExport data, response status code and response headers



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/authentik/api/api/events_api.rb', line 231

def events_events_export_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_export_create ...'
  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[:'actions'] && !opts[:'actions'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"actions\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/events/events/export/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'actions'] = @api_client.build_collection_param(opts[:'actions'], :multi) if !opts[:'actions'].nil?
  query_params[:'brand_name'] = opts[:'brand_name'] if !opts[:'brand_name'].nil?
  query_params[:'client_ip'] = opts[:'client_ip'] if !opts[:'client_ip'].nil?
  query_params[:'context_authorized_app'] = opts[:'context_authorized_app'] if !opts[:'context_authorized_app'].nil?
  query_params[:'context_model_app'] = opts[:'context_model_app'] if !opts[:'context_model_app'].nil?
  query_params[:'context_model_name'] = opts[:'context_model_name'] if !opts[:'context_model_name'].nil?
  query_params[:'context_model_pk'] = opts[:'context_model_pk'] if !opts[:'context_model_pk'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?

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

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

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

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

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

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

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

#events_events_list(opts = {}) ⇒ PaginatedEventList

Event Read-Only Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String)
  • :actions (Array<String>)
  • :brand_name (String) —

    Brand name

  • :client_ip (String)
  • :context_authorized_app (String) —

    Context Authorized application

  • :context_model_app (String) —

    Context Model App

  • :context_model_name (String) —

    Context Model Name

  • :context_model_pk (String) —

    Context Model Primary Key

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

  • :username (String) —

    Username

Returns:



306
307
308
309
 
# File 'lib/authentik/api/api/events_api.rb', line 306

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

#events_events_list_with_http_info(opts = {}) ⇒ Array<(PaginatedEventList, Integer, Hash)>

Event Read-Only Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String)
  • :actions (Array<String>)
  • :brand_name (String) —

    Brand name

  • :client_ip (String)
  • :context_authorized_app (String) —

    Context Authorized application

  • :context_model_app (String) —

    Context Model App

  • :context_model_name (String) —

    Context Model Name

  • :context_model_pk (String) —

    Context Model Primary Key

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

  • :username (String) —

    Username

Returns:

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

    PaginatedEventList data, response status code and response headers



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/authentik/api/api/events_api.rb', line 327

def events_events_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_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[:'actions'] && !opts[:'actions'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"actions\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/events/events/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'actions'] = @api_client.build_collection_param(opts[:'actions'], :multi) if !opts[:'actions'].nil?
  query_params[:'brand_name'] = opts[:'brand_name'] if !opts[:'brand_name'].nil?
  query_params[:'client_ip'] = opts[:'client_ip'] if !opts[:'client_ip'].nil?
  query_params[:'context_authorized_app'] = opts[:'context_authorized_app'] if !opts[:'context_authorized_app'].nil?
  query_params[:'context_model_app'] = opts[:'context_model_app'] if !opts[:'context_model_app'].nil?
  query_params[:'context_model_name'] = opts[:'context_model_name'] if !opts[:'context_model_name'].nil?
  query_params[:'context_model_pk'] = opts[:'context_model_pk'] if !opts[:'context_model_pk'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?

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

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

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

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

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

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

#events_events_partial_update(event_uuid, opts = {}) ⇒ Event

Event Read-Only Viewset

Parameters:

  • event_uuid (String) —

    A UUID string identifying this Event.

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

    the optional parameters

Options Hash (opts):

Returns:



393
394
395
396
 
# File 'lib/authentik/api/api/events_api.rb', line 393

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

#events_events_partial_update_with_http_info(event_uuid, opts = {}) ⇒ Array<(Event, Integer, Hash)>

Event Read-Only Viewset

Parameters:

  • event_uuid (String) —

    A UUID string identifying this Event.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Event data, response status code and response headers



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

def events_events_partial_update_with_http_info(event_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_partial_update ...'
  end
  # verify the required parameter 'event_uuid' is set
  if @api_client.config.client_side_validation && event_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'event_uuid' when calling EventsApi.events_events_partial_update"
  end
  # resource path
  local_var_path = '/events/events/{event_uuid}/'.sub('{event_uuid}', CGI.escape(event_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_request'])

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

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

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

#events_events_retrieve(event_uuid, opts = {}) ⇒ Event

Event Read-Only Viewset

Parameters:

  • event_uuid (String) —

    A UUID string identifying this Event.

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

    the optional parameters

Returns:



460
461
462
463
 
# File 'lib/authentik/api/api/events_api.rb', line 460

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

#events_events_retrieve_with_http_info(event_uuid, opts = {}) ⇒ Array<(Event, Integer, Hash)>

Event Read-Only Viewset

Parameters:

  • event_uuid (String) —

    A UUID string identifying this Event.

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

    the optional parameters

Returns:

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

    Event data, response status code and response headers



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
508
509
510
511
512
513
514
515
 
# File 'lib/authentik/api/api/events_api.rb', line 469

def events_events_retrieve_with_http_info(event_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_retrieve ...'
  end
  # verify the required parameter 'event_uuid' is set
  if @api_client.config.client_side_validation && event_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'event_uuid' when calling EventsApi.events_events_retrieve"
  end
  # resource path
  local_var_path = '/events/events/{event_uuid}/'.sub('{event_uuid}', CGI.escape(event_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] || 'Event'

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

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

#events_events_top_per_user_list(opts = {}) ⇒ Array<EventTopPerUser>

Get the top_n events grouped by user count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String)
  • :top_n (Integer)

Returns:



522
523
524
525
 
# File 'lib/authentik/api/api/events_api.rb', line 522

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

#events_events_top_per_user_list_with_http_info(opts = {}) ⇒ Array<(Array<EventTopPerUser>, Integer, Hash)>

Get the top_n events grouped by user count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String)
  • :top_n (Integer)

Returns:

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

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



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
574
575
576
 
# File 'lib/authentik/api/api/events_api.rb', line 532

def events_events_top_per_user_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_top_per_user_list ...'
  end
  # resource path
  local_var_path = '/events/events/top_per_user/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'top_n'] = opts[:'top_n'] if !opts[:'top_n'].nil?

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

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

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

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

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

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

#events_events_update(event_uuid, event_request, opts = {}) ⇒ Event

Event Read-Only Viewset

Parameters:

  • event_uuid (String) —

    A UUID string identifying this Event.

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

    the optional parameters

Returns:



583
584
585
586
 
# File 'lib/authentik/api/api/events_api.rb', line 583

def events_events_update(event_uuid, event_request, opts = {})
  data, _status_code, _headers = events_events_update_with_http_info(event_uuid, event_request, opts)
  data
end

#events_events_update_with_http_info(event_uuid, event_request, opts = {}) ⇒ Array<(Event, Integer, Hash)>

Event Read-Only Viewset

Parameters:

  • event_uuid (String) —

    A UUID string identifying this Event.

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

    the optional parameters

Returns:

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

    Event data, response status code and response headers



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

def events_events_update_with_http_info(event_uuid, event_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_update ...'
  end
  # verify the required parameter 'event_uuid' is set
  if @api_client.config.client_side_validation && event_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'event_uuid' when calling EventsApi.events_events_update"
  end
  # verify the required parameter 'event_request' is set
  if @api_client.config.client_side_validation && event_request.nil?
    fail ArgumentError, "Missing the required parameter 'event_request' when calling EventsApi.events_events_update"
  end
  # resource path
  local_var_path = '/events/events/{event_uuid}/'.sub('{event_uuid}', CGI.escape(event_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_request)

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

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

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

#events_events_volume_list(opts = {}) ⇒ Array<EventVolume>

Get event volume for specified filters and timeframe

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String)
  • :actions (Array<String>)
  • :brand_name (String) —

    Brand name

  • :client_ip (String)
  • :context_authorized_app (String) —

    Context Authorized application

  • :context_model_app (String) —

    Context Model App

  • :context_model_name (String) —

    Context Model Name

  • :context_model_pk (String) —

    Context Model Primary Key

  • :history_days (Float) — default: default to 7
  • :ordering (String) —

    Which field to use when ordering the results.

  • :search (String) —

    A search term.

  • :username (String) —

    Username

Returns:



665
666
667
668
 
# File 'lib/authentik/api/api/events_api.rb', line 665

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

#events_events_volume_list_with_http_info(opts = {}) ⇒ Array<(Array<EventVolume>, Integer, Hash)>

Get event volume for specified filters and timeframe

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :action (String)
  • :actions (Array<String>)
  • :brand_name (String) —

    Brand name

  • :client_ip (String)
  • :context_authorized_app (String) —

    Context Authorized application

  • :context_model_app (String) —

    Context Model App

  • :context_model_name (String) —

    Context Model Name

  • :context_model_pk (String) —

    Context Model Primary Key

  • :history_days (Float) — default: default to 7
  • :ordering (String) —

    Which field to use when ordering the results.

  • :search (String) —

    A search term.

  • :username (String) —

    Username

Returns:

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

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



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

def events_events_volume_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_events_volume_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[:'actions'] && !opts[:'actions'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"actions\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/events/events/volume/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'actions'] = @api_client.build_collection_param(opts[:'actions'], :multi) if !opts[:'actions'].nil?
  query_params[:'brand_name'] = opts[:'brand_name'] if !opts[:'brand_name'].nil?
  query_params[:'client_ip'] = opts[:'client_ip'] if !opts[:'client_ip'].nil?
  query_params[:'context_authorized_app'] = opts[:'context_authorized_app'] if !opts[:'context_authorized_app'].nil?
  query_params[:'context_model_app'] = opts[:'context_model_app'] if !opts[:'context_model_app'].nil?
  query_params[:'context_model_name'] = opts[:'context_model_name'] if !opts[:'context_model_name'].nil?
  query_params[:'context_model_pk'] = opts[:'context_model_pk'] if !opts[:'context_model_pk'].nil?
  query_params[:'history_days'] = opts[:'history_days'] if !opts[:'history_days'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?

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

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

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

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

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

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

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

Notification Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Returns:

  • (nil) 


749
750
751
752
 
# File 'lib/authentik/api/api/events_api.rb', line 749

def events_notifications_destroy(uuid, opts = {})
  events_notifications_destroy_with_http_info(uuid, opts)
  nil
end

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

Notification Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/authentik/api/api/events_api.rb', line 758

def events_notifications_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_notifications_destroy ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_notifications_destroy"
  end
  # resource path
  local_var_path = '/events/notifications/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#events_notifications_list(opts = {}) ⇒ PaginatedNotificationList

Notification Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (String)
  • :created (Time)
  • :event (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.

  • :seen (Boolean)
  • :severity (String)
  • :user (Integer)

Returns:



819
820
821
822
 
# File 'lib/authentik/api/api/events_api.rb', line 819

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

#events_notifications_list_with_http_info(opts = {}) ⇒ Array<(PaginatedNotificationList, Integer, Hash)>

Notification Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (String)
  • :created (Time)
  • :event (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.

  • :seen (Boolean)
  • :severity (String)
  • :user (Integer)

Returns:

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

    PaginatedNotificationList data, response status code and response headers



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

def events_notifications_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_notifications_list ...'
  end
  allowable_values = ["alert", "notice", "warning"]
  if @api_client.config.client_side_validation && opts[:'severity'] && !allowable_values.include?(opts[:'severity'])
    fail ArgumentError, "invalid value for \"severity\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/events/notifications/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'body'] = opts[:'body'] if !opts[:'body'].nil?
  query_params[:'created'] = opts[:'created'] if !opts[:'created'].nil?
  query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'seen'] = opts[:'seen'] if !opts[:'seen'].nil?
  query_params[:'severity'] = opts[:'severity'] if !opts[:'severity'].nil?
  query_params[:'user'] = opts[:'user'] if !opts[:'user'].nil?

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

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

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

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

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

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

#events_notifications_mark_all_seen_create(opts = {}) ⇒ nil

Mark all the user’s notifications as seen

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


898
899
900
901
 
# File 'lib/authentik/api/api/events_api.rb', line 898

def events_notifications_mark_all_seen_create(opts = {})
  events_notifications_mark_all_seen_create_with_http_info(opts)
  nil
end

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

Mark all the user&#39;s notifications as seen

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/authentik/api/api/events_api.rb', line 906

def events_notifications_mark_all_seen_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_notifications_mark_all_seen_create ...'
  end
  # resource path
  local_var_path = '/events/notifications/mark_all_seen/'

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

#events_notifications_partial_update(uuid, opts = {}) ⇒ Notification

Notification Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Options Hash (opts):

Returns:



955
956
957
958
 
# File 'lib/authentik/api/api/events_api.rb', line 955

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

#events_notifications_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Notification Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Notification data, response status code and response headers



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/authentik/api/api/events_api.rb', line 965

def events_notifications_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_notifications_partial_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_notifications_partial_update"
  end
  # resource path
  local_var_path = '/events/notifications/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#events_notifications_retrieve(uuid, opts = {}) ⇒ Notification

Notification Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Returns:



1022
1023
1024
1025
 
# File 'lib/authentik/api/api/events_api.rb', line 1022

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

#events_notifications_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Notification Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Returns:

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

    Notification data, response status code and response headers



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/authentik/api/api/events_api.rb', line 1031

def events_notifications_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_notifications_retrieve ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_notifications_retrieve"
  end
  # resource path
  local_var_path = '/events/notifications/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#events_notifications_update(uuid, opts = {}) ⇒ Notification

Notification Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Options Hash (opts):

Returns:



1084
1085
1086
1087
 
# File 'lib/authentik/api/api/events_api.rb', line 1084

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

#events_notifications_update_with_http_info(uuid, opts = {}) ⇒ Array<(Notification, Integer, Hash)>

Notification Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Notification data, response status code and response headers



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/authentik/api/api/events_api.rb', line 1094

def events_notifications_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_notifications_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_notifications_update"
  end
  # resource path
  local_var_path = '/events/notifications/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Returns:



1151
1152
1153
1154
 
# File 'lib/authentik/api/api/events_api.rb', line 1151

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification.

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

    the optional parameters

Returns:

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

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



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

def events_notifications_used_by_list_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_notifications_used_by_list ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_notifications_used_by_list"
  end
  # resource path
  local_var_path = '/events/notifications/{uuid}/used_by/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#events_rules_create(notification_rule_request, opts = {}) ⇒ NotificationRule

NotificationRule Viewset

Parameters:

Returns:



1212
1213
1214
1215
 
# File 'lib/authentik/api/api/events_api.rb', line 1212

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

#events_rules_create_with_http_info(notification_rule_request, opts = {}) ⇒ Array<(NotificationRule, Integer, Hash)>

NotificationRule Viewset

Parameters:

Returns:

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

    NotificationRule data, response status code and response headers



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
1271
1272
 
# File 'lib/authentik/api/api/events_api.rb', line 1221

def events_rules_create_with_http_info(notification_rule_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_rules_create ...'
  end
  # verify the required parameter 'notification_rule_request' is set
  if @api_client.config.client_side_validation && notification_rule_request.nil?
    fail ArgumentError, "Missing the required parameter 'notification_rule_request' when calling EventsApi.events_rules_create"
  end
  # resource path
  local_var_path = '/events/rules/'

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

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

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

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

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

NotificationRule Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Returns:

  • (nil) 


1278
1279
1280
1281
 
# File 'lib/authentik/api/api/events_api.rb', line 1278

def events_rules_destroy(pbm_uuid, opts = {})
  events_rules_destroy_with_http_info(pbm_uuid, opts)
  nil
end

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

NotificationRule Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def events_rules_destroy_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_rules_destroy ...'
  end
  # verify the required parameter 'pbm_uuid' is set
  if @api_client.config.client_side_validation && pbm_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'pbm_uuid' when calling EventsApi.events_rules_destroy"
  end
  # resource path
  local_var_path = '/events/rules/{pbm_uuid}/'.sub('{pbm_uuid}', CGI.escape(pbm_uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#events_rules_list(opts = {}) ⇒ PaginatedNotificationRuleList

NotificationRule Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :severity (String) —

    Controls which severity level the created notifications will have.

Returns:



1345
1346
1347
1348
 
# File 'lib/authentik/api/api/events_api.rb', line 1345

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

#events_rules_list_with_http_info(opts = {}) ⇒ Array<(PaginatedNotificationRuleList, Integer, Hash)>

NotificationRule Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :severity (String) —

    Controls which severity level the created notifications will have.

Returns:



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

def events_rules_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_rules_list ...'
  end
  allowable_values = ["alert", "notice", "warning"]
  if @api_client.config.client_side_validation && opts[:'severity'] && !allowable_values.include?(opts[:'severity'])
    fail ArgumentError, "invalid value for \"severity\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/events/rules/'

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

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

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

#events_rules_partial_update(pbm_uuid, opts = {}) ⇒ NotificationRule

NotificationRule Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Options Hash (opts):

Returns:



1420
1421
1422
1423
 
# File 'lib/authentik/api/api/events_api.rb', line 1420

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

#events_rules_partial_update_with_http_info(pbm_uuid, opts = {}) ⇒ Array<(NotificationRule, Integer, Hash)>

NotificationRule Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    NotificationRule data, response status code and response headers



1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/authentik/api/api/events_api.rb', line 1430

def events_rules_partial_update_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_rules_partial_update ...'
  end
  # verify the required parameter 'pbm_uuid' is set
  if @api_client.config.client_side_validation && pbm_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'pbm_uuid' when calling EventsApi.events_rules_partial_update"
  end
  # resource path
  local_var_path = '/events/rules/{pbm_uuid}/'.sub('{pbm_uuid}', CGI.escape(pbm_uuid.to_s))

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

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

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

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

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

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

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

#events_rules_retrieve(pbm_uuid, opts = {}) ⇒ NotificationRule

NotificationRule Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Returns:



1487
1488
1489
1490
 
# File 'lib/authentik/api/api/events_api.rb', line 1487

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

#events_rules_retrieve_with_http_info(pbm_uuid, opts = {}) ⇒ Array<(NotificationRule, Integer, Hash)>

NotificationRule Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Returns:

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

    NotificationRule data, response status code and response headers



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'lib/authentik/api/api/events_api.rb', line 1496

def events_rules_retrieve_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_rules_retrieve ...'
  end
  # verify the required parameter 'pbm_uuid' is set
  if @api_client.config.client_side_validation && pbm_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'pbm_uuid' when calling EventsApi.events_rules_retrieve"
  end
  # resource path
  local_var_path = '/events/rules/{pbm_uuid}/'.sub('{pbm_uuid}', CGI.escape(pbm_uuid.to_s))

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

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

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

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

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

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

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

#events_rules_update(pbm_uuid, notification_rule_request, opts = {}) ⇒ NotificationRule

NotificationRule Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Returns:



1549
1550
1551
1552
 
# File 'lib/authentik/api/api/events_api.rb', line 1549

def events_rules_update(pbm_uuid, notification_rule_request, opts = {})
  data, _status_code, _headers = events_rules_update_with_http_info(pbm_uuid, notification_rule_request, opts)
  data
end

#events_rules_update_with_http_info(pbm_uuid, notification_rule_request, opts = {}) ⇒ Array<(NotificationRule, Integer, Hash)>

NotificationRule Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Returns:

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

    NotificationRule data, response status code and response headers



1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
 
# File 'lib/authentik/api/api/events_api.rb', line 1559

def events_rules_update_with_http_info(pbm_uuid, notification_rule_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_rules_update ...'
  end
  # verify the required parameter 'pbm_uuid' is set
  if @api_client.config.client_side_validation && pbm_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'pbm_uuid' when calling EventsApi.events_rules_update"
  end
  # verify the required parameter 'notification_rule_request' is set
  if @api_client.config.client_side_validation && notification_rule_request.nil?
    fail ArgumentError, "Missing the required parameter 'notification_rule_request' when calling EventsApi.events_rules_update"
  end
  # resource path
  local_var_path = '/events/rules/{pbm_uuid}/'.sub('{pbm_uuid}', CGI.escape(pbm_uuid.to_s))

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

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

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

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

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

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

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

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

Get a list of all objects that use this object

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Returns:



1620
1621
1622
1623
 
# File 'lib/authentik/api/api/events_api.rb', line 1620

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

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

Get a list of all objects that use this object

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Notification Rule.

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

    the optional parameters

Returns:

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

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



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'lib/authentik/api/api/events_api.rb', line 1629

def events_rules_used_by_list_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_rules_used_by_list ...'
  end
  # verify the required parameter 'pbm_uuid' is set
  if @api_client.config.client_side_validation && pbm_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'pbm_uuid' when calling EventsApi.events_rules_used_by_list"
  end
  # resource path
  local_var_path = '/events/rules/{pbm_uuid}/used_by/'.sub('{pbm_uuid}', CGI.escape(pbm_uuid.to_s))

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

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

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

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

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

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

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

#events_transports_create(notification_transport_request, opts = {}) ⇒ NotificationTransport

NotificationTransport Viewset

Parameters:

Returns:



1681
1682
1683
1684
 
# File 'lib/authentik/api/api/events_api.rb', line 1681

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

#events_transports_create_with_http_info(notification_transport_request, opts = {}) ⇒ Array<(NotificationTransport, Integer, Hash)>

NotificationTransport Viewset

Parameters:

Returns:

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

    NotificationTransport data, response status code and response headers



1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
 
# File 'lib/authentik/api/api/events_api.rb', line 1690

def events_transports_create_with_http_info(notification_transport_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_transports_create ...'
  end
  # verify the required parameter 'notification_transport_request' is set
  if @api_client.config.client_side_validation && notification_transport_request.nil?
    fail ArgumentError, "Missing the required parameter 'notification_transport_request' when calling EventsApi.events_transports_create"
  end
  # resource path
  local_var_path = '/events/transports/'

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

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

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

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

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

NotificationTransport Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:

  • (nil) 


1747
1748
1749
1750
 
# File 'lib/authentik/api/api/events_api.rb', line 1747

def events_transports_destroy(uuid, opts = {})
  events_transports_destroy_with_http_info(uuid, opts)
  nil
end

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

NotificationTransport Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'lib/authentik/api/api/events_api.rb', line 1756

def events_transports_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_transports_destroy ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_transports_destroy"
  end
  # resource path
  local_var_path = '/events/transports/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#events_transports_list(opts = {}) ⇒ PaginatedNotificationTransportList

NotificationTransport Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :send_once (Boolean)
  • :webhook_url (String)

Returns:



1815
1816
1817
1818
 
# File 'lib/authentik/api/api/events_api.rb', line 1815

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

#events_transports_list_with_http_info(opts = {}) ⇒ Array<(PaginatedNotificationTransportList, Integer, Hash)>

NotificationTransport Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :send_once (Boolean)
  • :webhook_url (String)

Returns:



1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/authentik/api/api/events_api.rb', line 1831

def events_transports_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_transports_list ...'
  end
  allowable_values = ["email", "local", "webhook", "webhook_slack"]
  if @api_client.config.client_side_validation && opts[:'mode'] && !allowable_values.include?(opts[:'mode'])
    fail ArgumentError, "invalid value for \"mode\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/events/transports/'

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

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

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

#events_transports_partial_update(uuid, opts = {}) ⇒ NotificationTransport

NotificationTransport Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Options Hash (opts):

Returns:



1892
1893
1894
1895
 
# File 'lib/authentik/api/api/events_api.rb', line 1892

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

#events_transports_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(NotificationTransport, Integer, Hash)>

NotificationTransport Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    NotificationTransport data, response status code and response headers



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

def events_transports_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_transports_partial_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_transports_partial_update"
  end
  # resource path
  local_var_path = '/events/transports/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#events_transports_retrieve(uuid, opts = {}) ⇒ NotificationTransport

NotificationTransport Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:



1959
1960
1961
1962
 
# File 'lib/authentik/api/api/events_api.rb', line 1959

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

#events_transports_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(NotificationTransport, Integer, Hash)>

NotificationTransport Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:

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

    NotificationTransport data, response status code and response headers



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

def events_transports_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_transports_retrieve ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_transports_retrieve"
  end
  # resource path
  local_var_path = '/events/transports/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#events_transports_test_create(uuid, opts = {}) ⇒ NotificationTransportTest

Send example notification using selected transport. Requires Modify permissions.

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:



2020
2021
2022
2023
 
# File 'lib/authentik/api/api/events_api.rb', line 2020

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

#events_transports_test_create_with_http_info(uuid, opts = {}) ⇒ Array<(NotificationTransportTest, Integer, Hash)>

Send example notification using selected transport. Requires Modify permissions.

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:

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

    NotificationTransportTest data, response status code and response headers



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

def events_transports_test_create_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_transports_test_create ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_transports_test_create"
  end
  # resource path
  local_var_path = '/events/transports/{uuid}/test/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#events_transports_update(uuid, notification_transport_request, opts = {}) ⇒ NotificationTransport

NotificationTransport Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:



2082
2083
2084
2085
 
# File 'lib/authentik/api/api/events_api.rb', line 2082

def events_transports_update(uuid, notification_transport_request, opts = {})
  data, _status_code, _headers = events_transports_update_with_http_info(uuid, notification_transport_request, opts)
  data
end

#events_transports_update_with_http_info(uuid, notification_transport_request, opts = {}) ⇒ Array<(NotificationTransport, Integer, Hash)>

NotificationTransport Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:

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

    NotificationTransport data, response status code and response headers



2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
 
# File 'lib/authentik/api/api/events_api.rb', line 2092

def events_transports_update_with_http_info(uuid, notification_transport_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_transports_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_transports_update"
  end
  # verify the required parameter 'notification_transport_request' is set
  if @api_client.config.client_side_validation && notification_transport_request.nil?
    fail ArgumentError, "Missing the required parameter 'notification_transport_request' when calling EventsApi.events_transports_update"
  end
  # resource path
  local_var_path = '/events/transports/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:



2153
2154
2155
2156
 
# File 'lib/authentik/api/api/events_api.rb', line 2153

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Notification Transport.

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

    the optional parameters

Returns:

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

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



2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
 
# File 'lib/authentik/api/api/events_api.rb', line 2162

def events_transports_used_by_list_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_transports_used_by_list ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling EventsApi.events_transports_used_by_list"
  end
  # resource path
  local_var_path = '/events/transports/{uuid}/used_by/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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