Class: Authentik::Api::EndpointsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EndpointsApi

Returns a new instance of EndpointsApi.



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

def api_client
  @api_client
end

Instance Method Details

#endpoints_agents_connectors_agent_config_retrieve(opts = {}) ⇒ AgentConfig

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:



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

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

#endpoints_agents_connectors_agent_config_retrieve_with_http_info(opts = {}) ⇒ Array<(AgentConfig, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:

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

    AgentConfig 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/endpoints_api.rb', line 27

def endpoints_agents_connectors_agent_config_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_agent_config_retrieve ...'
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/agent_config/'

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

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

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

#endpoints_agents_connectors_auth_fed_create(device, opts = {}) ⇒ AgentTokenResponse

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:



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

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

#endpoints_agents_connectors_auth_fed_create_with_http_info(device, opts = {}) ⇒ Array<(AgentTokenResponse, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:

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

    AgentTokenResponse 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
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 84

def endpoints_agents_connectors_auth_fed_create_with_http_info(device, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_auth_fed_create ...'
  end
  # verify the required parameter 'device' is set
  if @api_client.config.client_side_validation && device.nil?
    fail ArgumentError, "Missing the required parameter 'device' when calling EndpointsApi.endpoints_agents_connectors_auth_fed_create"
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/auth_fed/'

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

  # header parameters
  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] || 'AgentTokenResponse'

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

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

#endpoints_agents_connectors_auth_ia_create(opts = {}) ⇒ AgentAuthenticationResponse

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 136

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

#endpoints_agents_connectors_auth_ia_create_with_http_info(opts = {}) ⇒ Array<(AgentAuthenticationResponse, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:

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

    AgentAuthenticationResponse data, response status code and response headers



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

def endpoints_agents_connectors_auth_ia_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_auth_ia_create ...'
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/auth_ia/'

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

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

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

#endpoints_agents_connectors_check_in_create(opts = {}) ⇒ nil

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


192
193
194
195
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 192

def endpoints_agents_connectors_check_in_create(opts = {})
  endpoints_agents_connectors_check_in_create_with_http_info(opts)
  nil
end

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

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 201

def endpoints_agents_connectors_check_in_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_check_in_create ...'
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/check_in/'

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#endpoints_agents_connectors_create(agent_connector_request, opts = {}) ⇒ AgentConnector

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:



254
255
256
257
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 254

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

#endpoints_agents_connectors_create_with_http_info(agent_connector_request, opts = {}) ⇒ Array<(AgentConnector, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:

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

    AgentConnector data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 263

def endpoints_agents_connectors_create_with_http_info(agent_connector_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_create ...'
  end
  # verify the required parameter 'agent_connector_request' is set
  if @api_client.config.client_side_validation && agent_connector_request.nil?
    fail ArgumentError, "Missing the required parameter 'agent_connector_request' when calling EndpointsApi.endpoints_agents_connectors_create"
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/'

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

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

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

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

#endpoints_agents_connectors_destroy(connector_uuid, opts = {}) ⇒ nil

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:

  • (nil) 


320
321
322
323
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 320

def endpoints_agents_connectors_destroy(connector_uuid, opts = {})
  endpoints_agents_connectors_destroy_with_http_info(connector_uuid, opts)
  nil
end

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

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def endpoints_agents_connectors_destroy_with_http_info(connector_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_destroy ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_agents_connectors_destroy"
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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 => :"EndpointsApi.endpoints_agents_connectors_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: EndpointsApi#endpoints_agents_connectors_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#endpoints_agents_connectors_enroll_create(enroll_request, opts = {}) ⇒ AgentTokenResponse

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:



381
382
383
384
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 381

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

#endpoints_agents_connectors_enroll_create_with_http_info(enroll_request, opts = {}) ⇒ Array<(AgentTokenResponse, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:

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

    AgentTokenResponse data, response status code and response headers



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

def endpoints_agents_connectors_enroll_create_with_http_info(enroll_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_enroll_create ...'
  end
  # verify the required parameter 'enroll_request' is set
  if @api_client.config.client_side_validation && enroll_request.nil?
    fail ArgumentError, "Missing the required parameter 'enroll_request' when calling EndpointsApi.endpoints_agents_connectors_enroll_create"
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/enroll/'

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

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

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

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

#endpoints_agents_connectors_list(opts = {}) ⇒ PaginatedAgentConnectorList

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:



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

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

#endpoints_agents_connectors_list_with_http_info(opts = {}) ⇒ Array<(PaginatedAgentConnectorList, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:

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

    PaginatedAgentConnectorList data, response status code and response headers



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 466

def endpoints_agents_connectors_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_list ...'
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/'

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

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

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

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

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

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

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

#endpoints_agents_connectors_mdm_config_create(connector_uuid, mdm_config_request, opts = {}) ⇒ MDMConfigResponse

Generate configuration for MDM systems to deploy authentik Agent

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:



521
522
523
524
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 521

def endpoints_agents_connectors_mdm_config_create(connector_uuid, mdm_config_request, opts = {})
  data, _status_code, _headers = endpoints_agents_connectors_mdm_config_create_with_http_info(connector_uuid, mdm_config_request, opts)
  data
end

#endpoints_agents_connectors_mdm_config_create_with_http_info(connector_uuid, mdm_config_request, opts = {}) ⇒ Array<(MDMConfigResponse, Integer, Hash)>

Generate configuration for MDM systems to deploy authentik Agent

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:

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

    MDMConfigResponse data, response status code and response headers



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 531

def endpoints_agents_connectors_mdm_config_create_with_http_info(connector_uuid, mdm_config_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_mdm_config_create ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_agents_connectors_mdm_config_create"
  end
  # verify the required parameter 'mdm_config_request' is set
  if @api_client.config.client_side_validation && mdm_config_request.nil?
    fail ArgumentError, "Missing the required parameter 'mdm_config_request' when calling EndpointsApi.endpoints_agents_connectors_mdm_config_create"
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/{connector_uuid}/mdm_config/'.sub('{connector_uuid}', CGI.escape(connector_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(mdm_config_request)

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

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

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

#endpoints_agents_connectors_partial_update(connector_uuid, opts = {}) ⇒ AgentConnector

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Options Hash (opts):

Returns:



593
594
595
596
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 593

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

#endpoints_agents_connectors_partial_update_with_http_info(connector_uuid, opts = {}) ⇒ Array<(AgentConnector, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AgentConnector data, response status code and response headers



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
649
650
651
652
653
654
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 603

def endpoints_agents_connectors_partial_update_with_http_info(connector_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_partial_update ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_agents_connectors_partial_update"
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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_agent_connector_request'])

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

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

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

#endpoints_agents_connectors_retrieve(connector_uuid, opts = {}) ⇒ AgentConnector

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:



660
661
662
663
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 660

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

#endpoints_agents_connectors_retrieve_with_http_info(connector_uuid, opts = {}) ⇒ Array<(AgentConnector, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:

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

    AgentConnector data, response status code and response headers



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

def endpoints_agents_connectors_retrieve_with_http_info(connector_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_retrieve ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_agents_connectors_retrieve"
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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] || 'AgentConnector'

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

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

#endpoints_agents_connectors_update(connector_uuid, agent_connector_request, opts = {}) ⇒ AgentConnector

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:



722
723
724
725
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 722

def endpoints_agents_connectors_update(connector_uuid, agent_connector_request, opts = {})
  data, _status_code, _headers = endpoints_agents_connectors_update_with_http_info(connector_uuid, agent_connector_request, opts)
  data
end

#endpoints_agents_connectors_update_with_http_info(connector_uuid, agent_connector_request, opts = {}) ⇒ Array<(AgentConnector, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:

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

    AgentConnector data, response status code and response headers



732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 732

def endpoints_agents_connectors_update_with_http_info(connector_uuid, agent_connector_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_connectors_update ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_agents_connectors_update"
  end
  # verify the required parameter 'agent_connector_request' is set
  if @api_client.config.client_side_validation && agent_connector_request.nil?
    fail ArgumentError, "Missing the required parameter 'agent_connector_request' when calling EndpointsApi.endpoints_agents_connectors_update"
  end
  # resource path
  local_var_path = '/endpoints/agents/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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(agent_connector_request)

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

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

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

#endpoints_agents_connectors_used_by_list(connector_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:



793
794
795
796
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 793

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

#endpoints_agents_connectors_used_by_list_with_http_info(connector_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Agent Connector.

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

    the optional parameters

Returns:

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

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



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 802

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

#endpoints_agents_enrollment_tokens_create(enrollment_token_request, opts = {}) ⇒ EnrollmentToken

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

Returns:



854
855
856
857
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 854

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

#endpoints_agents_enrollment_tokens_create_with_http_info(enrollment_token_request, opts = {}) ⇒ Array<(EnrollmentToken, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

Returns:

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

    EnrollmentToken data, response status code and response headers



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
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 863

def endpoints_agents_enrollment_tokens_create_with_http_info(enrollment_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_enrollment_tokens_create ...'
  end
  # verify the required parameter 'enrollment_token_request' is set
  if @api_client.config.client_side_validation && enrollment_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'enrollment_token_request' when calling EndpointsApi.endpoints_agents_enrollment_tokens_create"
  end
  # resource path
  local_var_path = '/endpoints/agents/enrollment_tokens/'

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

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

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

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

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

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

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

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

#endpoints_agents_enrollment_tokens_destroy(token_uuid, opts = {}) ⇒ nil

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:

  • (nil) 


920
921
922
923
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 920

def endpoints_agents_enrollment_tokens_destroy(token_uuid, opts = {})
  endpoints_agents_enrollment_tokens_destroy_with_http_info(token_uuid, opts)
  nil
end

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

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 929

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

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

#endpoints_agents_enrollment_tokens_list(opts = {}) ⇒ PaginatedEnrollmentTokenList

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :token_uuid (String)

Returns:



986
987
988
989
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 986

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

#endpoints_agents_enrollment_tokens_list_with_http_info(opts = {}) ⇒ Array<(PaginatedEnrollmentTokenList, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :token_uuid (String)

Returns:



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1000

def endpoints_agents_enrollment_tokens_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_enrollment_tokens_list ...'
  end
  # resource path
  local_var_path = '/endpoints/agents/enrollment_tokens/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'connector'] = opts[:'connector'] if !opts[:'connector'].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[:'token_uuid'] = opts[:'token_uuid'] if !opts[:'token_uuid'].nil?

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

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

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

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

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

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

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

#endpoints_agents_enrollment_tokens_partial_update(token_uuid, opts = {}) ⇒ EnrollmentToken

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Options Hash (opts):

Returns:



1055
1056
1057
1058
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1055

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

#endpoints_agents_enrollment_tokens_partial_update_with_http_info(token_uuid, opts = {}) ⇒ Array<(EnrollmentToken, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EnrollmentToken data, response status code and response headers



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

def endpoints_agents_enrollment_tokens_partial_update_with_http_info(token_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_enrollment_tokens_partial_update ...'
  end
  # verify the required parameter 'token_uuid' is set
  if @api_client.config.client_side_validation && token_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'token_uuid' when calling EndpointsApi.endpoints_agents_enrollment_tokens_partial_update"
  end
  # resource path
  local_var_path = '/endpoints/agents/enrollment_tokens/{token_uuid}/'.sub('{token_uuid}', CGI.escape(token_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_enrollment_token_request'])

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

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

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

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

#endpoints_agents_enrollment_tokens_retrieve(token_uuid, opts = {}) ⇒ EnrollmentToken

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:



1122
1123
1124
1125
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1122

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

#endpoints_agents_enrollment_tokens_retrieve_with_http_info(token_uuid, opts = {}) ⇒ Array<(EnrollmentToken, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:

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

    EnrollmentToken data, response status code and response headers



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1131

def endpoints_agents_enrollment_tokens_retrieve_with_http_info(token_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_enrollment_tokens_retrieve ...'
  end
  # verify the required parameter 'token_uuid' is set
  if @api_client.config.client_side_validation && token_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'token_uuid' when calling EndpointsApi.endpoints_agents_enrollment_tokens_retrieve"
  end
  # resource path
  local_var_path = '/endpoints/agents/enrollment_tokens/{token_uuid}/'.sub('{token_uuid}', CGI.escape(token_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] || 'EnrollmentToken'

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

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

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

#endpoints_agents_enrollment_tokens_update(token_uuid, enrollment_token_request, opts = {}) ⇒ EnrollmentToken

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:



1184
1185
1186
1187
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1184

def endpoints_agents_enrollment_tokens_update(token_uuid, enrollment_token_request, opts = {})
  data, _status_code, _headers = endpoints_agents_enrollment_tokens_update_with_http_info(token_uuid, enrollment_token_request, opts)
  data
end

#endpoints_agents_enrollment_tokens_update_with_http_info(token_uuid, enrollment_token_request, opts = {}) ⇒ Array<(EnrollmentToken, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:

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

    EnrollmentToken data, response status code and response headers



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1194

def endpoints_agents_enrollment_tokens_update_with_http_info(token_uuid, enrollment_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_enrollment_tokens_update ...'
  end
  # verify the required parameter 'token_uuid' is set
  if @api_client.config.client_side_validation && token_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'token_uuid' when calling EndpointsApi.endpoints_agents_enrollment_tokens_update"
  end
  # verify the required parameter 'enrollment_token_request' is set
  if @api_client.config.client_side_validation && enrollment_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'enrollment_token_request' when calling EndpointsApi.endpoints_agents_enrollment_tokens_update"
  end
  # resource path
  local_var_path = '/endpoints/agents/enrollment_tokens/{token_uuid}/'.sub('{token_uuid}', CGI.escape(token_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(enrollment_token_request)

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

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

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

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

#endpoints_agents_enrollment_tokens_used_by_list(token_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:



1255
1256
1257
1258
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1255

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

#endpoints_agents_enrollment_tokens_used_by_list_with_http_info(token_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:

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

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



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1264

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

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

#endpoints_agents_enrollment_tokens_view_key_retrieve(token_uuid, opts = {}) ⇒ TokenView

Return token key and log access

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:



1316
1317
1318
1319
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1316

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

#endpoints_agents_enrollment_tokens_view_key_retrieve_with_http_info(token_uuid, opts = {}) ⇒ Array<(TokenView, Integer, Hash)>

Return token key and log access

Parameters:

  • token_uuid (String) —

    A UUID string identifying this Enrollment Token.

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

    the optional parameters

Returns:

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

    TokenView data, response status code and response headers



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1325

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

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

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

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

#endpoints_agents_psso_register_device_create(agent_psso_device_registration_request, opts = {}) ⇒ AgentPSSODeviceRegistrationResponse

Parameters:

Returns:



1376
1377
1378
1379
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1376

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

#endpoints_agents_psso_register_device_create_with_http_info(agent_psso_device_registration_request, opts = {}) ⇒ Array<(AgentPSSODeviceRegistrationResponse, Integer, Hash)>

Returns AgentPSSODeviceRegistrationResponse data, response status code and response headers.

Parameters:

Returns:



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
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1384

def endpoints_agents_psso_register_device_create_with_http_info(agent_psso_device_registration_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_psso_register_device_create ...'
  end
  # verify the required parameter 'agent_psso_device_registration_request' is set
  if @api_client.config.client_side_validation && agent_psso_device_registration_request.nil?
    fail ArgumentError, "Missing the required parameter 'agent_psso_device_registration_request' when calling EndpointsApi.endpoints_agents_psso_register_device_create"
  end
  # resource path
  local_var_path = '/endpoints/agents/psso/register/device/'

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

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

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

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

#endpoints_agents_psso_register_user_create(agent_psso_user_registration_request, opts = {}) ⇒ UserSelf

Parameters:

Returns:



1440
1441
1442
1443
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1440

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

#endpoints_agents_psso_register_user_create_with_http_info(agent_psso_user_registration_request, opts = {}) ⇒ Array<(UserSelf, Integer, Hash)>

Returns UserSelf data, response status code and response headers.

Parameters:

Returns:

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

    UserSelf data, response status code and response headers



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
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1448

def endpoints_agents_psso_register_user_create_with_http_info(agent_psso_user_registration_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_agents_psso_register_user_create ...'
  end
  # verify the required parameter 'agent_psso_user_registration_request' is set
  if @api_client.config.client_side_validation && agent_psso_user_registration_request.nil?
    fail ArgumentError, "Missing the required parameter 'agent_psso_user_registration_request' when calling EndpointsApi.endpoints_agents_psso_register_user_create"
  end
  # resource path
  local_var_path = '/endpoints/agents/psso/register/user/'

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

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

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

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

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

#endpoints_connectors_destroy(connector_uuid, opts = {}) ⇒ nil

Connector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this connector.

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

    the optional parameters

Returns:

  • (nil) 


1505
1506
1507
1508
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1505

def endpoints_connectors_destroy(connector_uuid, opts = {})
  endpoints_connectors_destroy_with_http_info(connector_uuid, opts)
  nil
end

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

Connector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this connector.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1514

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

#endpoints_connectors_list(opts = {}) ⇒ PaginatedConnectorList

Connector Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:



1569
1570
1571
1572
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1569

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

#endpoints_connectors_list_with_http_info(opts = {}) ⇒ Array<(PaginatedConnectorList, Integer, Hash)>

Connector Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:

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

    PaginatedConnectorList data, response status code and response headers



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
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1581

def endpoints_connectors_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_connectors_list ...'
  end
  # resource path
  local_var_path = '/endpoints/connectors/'

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

  # header parameters
  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] || 'PaginatedConnectorList'

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

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

#endpoints_connectors_retrieve(connector_uuid, opts = {}) ⇒ Connector

Connector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this connector.

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

    the optional parameters

Returns:



1633
1634
1635
1636
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1633

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

#endpoints_connectors_retrieve_with_http_info(connector_uuid, opts = {}) ⇒ Array<(Connector, Integer, Hash)>

Connector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this connector.

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

    the optional parameters

Returns:

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

    Connector data, response status code and response headers



1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1642

def endpoints_connectors_retrieve_with_http_info(connector_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_connectors_retrieve ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_connectors_retrieve"
  end
  # resource path
  local_var_path = '/endpoints/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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] || 'Connector'

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

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

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

Get all creatable types

Parameters:

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

    the optional parameters

Returns:



1693
1694
1695
1696
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1693

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

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

Get all creatable types

Parameters:

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

    the optional parameters

Returns:

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

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



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
1742
1743
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1701

def endpoints_connectors_types_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_connectors_types_list ...'
  end
  # resource path
  local_var_path = '/endpoints/connectors/types/'

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

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

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

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

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

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

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

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

#endpoints_connectors_used_by_list(connector_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this connector.

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

    the optional parameters

Returns:



1749
1750
1751
1752
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1749

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

#endpoints_connectors_used_by_list_with_http_info(connector_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this connector.

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

    the optional parameters

Returns:

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

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



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
1803
1804
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1758

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

#endpoints_device_access_groups_create(device_access_group_request, opts = {}) ⇒ DeviceAccessGroup

DeviceAccessGroup Viewset

Parameters:

Returns:



1810
1811
1812
1813
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1810

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

#endpoints_device_access_groups_create_with_http_info(device_access_group_request, opts = {}) ⇒ Array<(DeviceAccessGroup, Integer, Hash)>

DeviceAccessGroup Viewset

Parameters:

Returns:

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

    DeviceAccessGroup data, response status code and response headers



1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1819

def endpoints_device_access_groups_create_with_http_info(device_access_group_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_access_groups_create ...'
  end
  # verify the required parameter 'device_access_group_request' is set
  if @api_client.config.client_side_validation && device_access_group_request.nil?
    fail ArgumentError, "Missing the required parameter 'device_access_group_request' when calling EndpointsApi.endpoints_device_access_groups_create"
  end
  # resource path
  local_var_path = '/endpoints/device_access_groups/'

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

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

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

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

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

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

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

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

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

DeviceAccessGroup Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Device access group.

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

    the optional parameters

Returns:

  • (nil) 


1876
1877
1878
1879
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1876

def endpoints_device_access_groups_destroy(pbm_uuid, opts = {})
  endpoints_device_access_groups_destroy_with_http_info(pbm_uuid, opts)
  nil
end

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

DeviceAccessGroup Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Device access group.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def endpoints_device_access_groups_destroy_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_access_groups_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 EndpointsApi.endpoints_device_access_groups_destroy"
  end
  # resource path
  local_var_path = '/endpoints/device_access_groups/{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 => :"EndpointsApi.endpoints_device_access_groups_destroy",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#endpoints_device_access_groups_list(opts = {}) ⇒ PaginatedDeviceAccessGroupList

DeviceAccessGroup Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

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

    A search term.

Returns:



1942
1943
1944
1945
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1942

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

#endpoints_device_access_groups_list_with_http_info(opts = {}) ⇒ Array<(PaginatedDeviceAccessGroupList, Integer, Hash)>

DeviceAccessGroup Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

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

    A search term.

Returns:



1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 1956

def endpoints_device_access_groups_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_access_groups_list ...'
  end
  # resource path
  local_var_path = '/endpoints/device_access_groups/'

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

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

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

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

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

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

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

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

#endpoints_device_access_groups_partial_update(pbm_uuid, opts = {}) ⇒ DeviceAccessGroup

DeviceAccessGroup Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Device access group.

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

    the optional parameters

Options Hash (opts):

Returns:



2011
2012
2013
2014
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2011

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

#endpoints_device_access_groups_partial_update_with_http_info(pbm_uuid, opts = {}) ⇒ Array<(DeviceAccessGroup, Integer, Hash)>

DeviceAccessGroup Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Device access group.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DeviceAccessGroup data, response status code and response headers



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

def endpoints_device_access_groups_partial_update_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_access_groups_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 EndpointsApi.endpoints_device_access_groups_partial_update"
  end
  # resource path
  local_var_path = '/endpoints/device_access_groups/{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_device_access_group_request'])

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

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

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

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

#endpoints_device_access_groups_retrieve(pbm_uuid, opts = {}) ⇒ DeviceAccessGroup

DeviceAccessGroup Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Device access group.

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

    the optional parameters

Returns:



2078
2079
2080
2081
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2078

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

#endpoints_device_access_groups_retrieve_with_http_info(pbm_uuid, opts = {}) ⇒ Array<(DeviceAccessGroup, Integer, Hash)>

DeviceAccessGroup Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Device access group.

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

    the optional parameters

Returns:

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

    DeviceAccessGroup data, response status code and response headers



2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2087

def endpoints_device_access_groups_retrieve_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_access_groups_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 EndpointsApi.endpoints_device_access_groups_retrieve"
  end
  # resource path
  local_var_path = '/endpoints/device_access_groups/{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] || 'DeviceAccessGroup'

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

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

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

#endpoints_device_access_groups_update(pbm_uuid, device_access_group_request, opts = {}) ⇒ DeviceAccessGroup

DeviceAccessGroup Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Device access group.

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

    the optional parameters

Returns:



2140
2141
2142
2143
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2140

def endpoints_device_access_groups_update(pbm_uuid, device_access_group_request, opts = {})
  data, _status_code, _headers = endpoints_device_access_groups_update_with_http_info(pbm_uuid, device_access_group_request, opts)
  data
end

#endpoints_device_access_groups_update_with_http_info(pbm_uuid, device_access_group_request, opts = {}) ⇒ Array<(DeviceAccessGroup, Integer, Hash)>

DeviceAccessGroup Viewset

Parameters:

  • pbm_uuid (String) —

    A UUID string identifying this Device access group.

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

    the optional parameters

Returns:

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

    DeviceAccessGroup data, response status code and response headers



2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2150

def endpoints_device_access_groups_update_with_http_info(pbm_uuid, device_access_group_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_access_groups_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 EndpointsApi.endpoints_device_access_groups_update"
  end
  # verify the required parameter 'device_access_group_request' is set
  if @api_client.config.client_side_validation && device_access_group_request.nil?
    fail ArgumentError, "Missing the required parameter 'device_access_group_request' when calling EndpointsApi.endpoints_device_access_groups_update"
  end
  # resource path
  local_var_path = '/endpoints/device_access_groups/{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(device_access_group_request)

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

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

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

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

#endpoints_device_access_groups_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 Device access group.

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

    the optional parameters

Returns:



2211
2212
2213
2214
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2211

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

#endpoints_device_access_groups_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 Device access group.

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

    the optional parameters

Returns:

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

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



2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2220

def endpoints_device_access_groups_used_by_list_with_http_info(pbm_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_access_groups_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 EndpointsApi.endpoints_device_access_groups_used_by_list"
  end
  # resource path
  local_var_path = '/endpoints/device_access_groups/{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 => :"EndpointsApi.endpoints_device_access_groups_used_by_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#endpoints_device_bindings_create(device_user_binding_request, opts = {}) ⇒ DeviceUserBinding

PolicyBinding Viewset

Parameters:

Returns:



2272
2273
2274
2275
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2272

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

#endpoints_device_bindings_create_with_http_info(device_user_binding_request, opts = {}) ⇒ Array<(DeviceUserBinding, Integer, Hash)>

PolicyBinding Viewset

Parameters:

Returns:

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

    DeviceUserBinding data, response status code and response headers



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

def endpoints_device_bindings_create_with_http_info(device_user_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_bindings_create ...'
  end
  # verify the required parameter 'device_user_binding_request' is set
  if @api_client.config.client_side_validation && device_user_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'device_user_binding_request' when calling EndpointsApi.endpoints_device_bindings_create"
  end
  # resource path
  local_var_path = '/endpoints/device_bindings/'

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

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

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

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

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

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

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

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

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

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Returns:

  • (nil) 


2338
2339
2340
2341
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2338

def endpoints_device_bindings_destroy(policy_binding_uuid, opts = {})
  endpoints_device_bindings_destroy_with_http_info(policy_binding_uuid, opts)
  nil
end

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

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def endpoints_device_bindings_destroy_with_http_info(policy_binding_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_bindings_destroy ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling EndpointsApi.endpoints_device_bindings_destroy"
  end
  # resource path
  local_var_path = '/endpoints/device_bindings/{policy_binding_uuid}/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#endpoints_device_bindings_list(opts = {}) ⇒ PaginatedDeviceUserBindingList

PolicyBinding Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

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

    A search term.

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

Returns:



2409
2410
2411
2412
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2409

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

#endpoints_device_bindings_list_with_http_info(opts = {}) ⇒ Array<(PaginatedDeviceUserBindingList, Integer, Hash)>

PolicyBinding Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

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

    A search term.

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

Returns:



2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2428

def endpoints_device_bindings_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_bindings_list ...'
  end
  # resource path
  local_var_path = '/endpoints/device_bindings/'

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

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

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

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

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

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

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

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

#endpoints_device_bindings_partial_update(policy_binding_uuid, opts = {}) ⇒ DeviceUserBinding

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Options Hash (opts):

Returns:



2488
2489
2490
2491
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2488

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

#endpoints_device_bindings_partial_update_with_http_info(policy_binding_uuid, opts = {}) ⇒ Array<(DeviceUserBinding, Integer, Hash)>

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DeviceUserBinding data, response status code and response headers



2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2498

def endpoints_device_bindings_partial_update_with_http_info(policy_binding_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_bindings_partial_update ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling EndpointsApi.endpoints_device_bindings_partial_update"
  end
  # resource path
  local_var_path = '/endpoints/device_bindings/{policy_binding_uuid}/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_uuid.to_s))

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

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

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

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

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

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

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

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

#endpoints_device_bindings_retrieve(policy_binding_uuid, opts = {}) ⇒ DeviceUserBinding

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Returns:



2555
2556
2557
2558
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2555

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

#endpoints_device_bindings_retrieve_with_http_info(policy_binding_uuid, opts = {}) ⇒ Array<(DeviceUserBinding, Integer, Hash)>

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Returns:

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

    DeviceUserBinding data, response status code and response headers



2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2564

def endpoints_device_bindings_retrieve_with_http_info(policy_binding_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_bindings_retrieve ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling EndpointsApi.endpoints_device_bindings_retrieve"
  end
  # resource path
  local_var_path = '/endpoints/device_bindings/{policy_binding_uuid}/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_uuid.to_s))

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

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

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

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

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

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

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

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

#endpoints_device_bindings_update(policy_binding_uuid, device_user_binding_request, opts = {}) ⇒ DeviceUserBinding

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Returns:



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

def endpoints_device_bindings_update(policy_binding_uuid, device_user_binding_request, opts = {})
  data, _status_code, _headers = endpoints_device_bindings_update_with_http_info(policy_binding_uuid, device_user_binding_request, opts)
  data
end

#endpoints_device_bindings_update_with_http_info(policy_binding_uuid, device_user_binding_request, opts = {}) ⇒ Array<(DeviceUserBinding, Integer, Hash)>

PolicyBinding Viewset

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Returns:

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

    DeviceUserBinding data, response status code and response headers



2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2627

def endpoints_device_bindings_update_with_http_info(policy_binding_uuid, device_user_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_bindings_update ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling EndpointsApi.endpoints_device_bindings_update"
  end
  # verify the required parameter 'device_user_binding_request' is set
  if @api_client.config.client_side_validation && device_user_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'device_user_binding_request' when calling EndpointsApi.endpoints_device_bindings_update"
  end
  # resource path
  local_var_path = '/endpoints/device_bindings/{policy_binding_uuid}/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_uuid.to_s))

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

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

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

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

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

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

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

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

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

Get a list of all objects that use this object

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Returns:



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

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

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

Get a list of all objects that use this object

Parameters:

  • policy_binding_uuid (String) —

    A UUID string identifying this Device User binding.

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

    the optional parameters

Returns:

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

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



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

def endpoints_device_bindings_used_by_list_with_http_info(policy_binding_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_device_bindings_used_by_list ...'
  end
  # verify the required parameter 'policy_binding_uuid' is set
  if @api_client.config.client_side_validation && policy_binding_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'policy_binding_uuid' when calling EndpointsApi.endpoints_device_bindings_used_by_list"
  end
  # resource path
  local_var_path = '/endpoints/device_bindings/{policy_binding_uuid}/used_by/'.sub('{policy_binding_uuid}', CGI.escape(policy_binding_uuid.to_s))

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

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

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

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

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

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

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

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

#endpoints_devices_destroy(device_uuid, opts = {}) ⇒ nil

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Returns:

  • (nil) 


2749
2750
2751
2752
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2749

def endpoints_devices_destroy(device_uuid, opts = {})
  endpoints_devices_destroy_with_http_info(device_uuid, opts)
  nil
end

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

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#endpoints_devices_list(opts = {}) ⇒ PaginatedEndpointDeviceList

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



2815
2816
2817
2818
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2815

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

#endpoints_devices_list_with_http_info(opts = {}) ⇒ Array<(PaginatedEndpointDeviceList, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    PaginatedEndpointDeviceList data, response status code and response headers



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

def endpoints_devices_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_devices_list ...'
  end
  # resource path
  local_var_path = '/endpoints/devices/'

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

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

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

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

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

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

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

#endpoints_devices_partial_update(device_uuid, opts = {}) ⇒ EndpointDevice

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Options Hash (opts):

Returns:



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

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

#endpoints_devices_partial_update_with_http_info(device_uuid, opts = {}) ⇒ Array<(EndpointDevice, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EndpointDevice data, response status code and response headers



2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2894

def endpoints_devices_partial_update_with_http_info(device_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_devices_partial_update ...'
  end
  # verify the required parameter 'device_uuid' is set
  if @api_client.config.client_side_validation && device_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'device_uuid' when calling EndpointsApi.endpoints_devices_partial_update"
  end
  # resource path
  local_var_path = '/endpoints/devices/{device_uuid}/'.sub('{device_uuid}', CGI.escape(device_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_endpoint_device_request'])

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

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

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

#endpoints_devices_retrieve(device_uuid, opts = {}) ⇒ EndpointDeviceDetails

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Returns:



2951
2952
2953
2954
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2951

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

#endpoints_devices_retrieve_with_http_info(device_uuid, opts = {}) ⇒ Array<(EndpointDeviceDetails, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Returns:

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

    EndpointDeviceDetails data, response status code and response headers



2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 2960

def endpoints_devices_retrieve_with_http_info(device_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_devices_retrieve ...'
  end
  # verify the required parameter 'device_uuid' is set
  if @api_client.config.client_side_validation && device_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'device_uuid' when calling EndpointsApi.endpoints_devices_retrieve"
  end
  # resource path
  local_var_path = '/endpoints/devices/{device_uuid}/'.sub('{device_uuid}', CGI.escape(device_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] || 'EndpointDeviceDetails'

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

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

#endpoints_devices_summary_retrieve(opts = {}) ⇒ DeviceSummary

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:



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

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

#endpoints_devices_summary_retrieve_with_http_info(opts = {}) ⇒ Array<(DeviceSummary, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

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

    the optional parameters

Returns:

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

    DeviceSummary data, response status code and response headers



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

def endpoints_devices_summary_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_devices_summary_retrieve ...'
  end
  # resource path
  local_var_path = '/endpoints/devices/summary/'

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

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

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

#endpoints_devices_update(device_uuid, endpoint_device_request, opts = {}) ⇒ EndpointDevice

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Returns:



3068
3069
3070
3071
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3068

def endpoints_devices_update(device_uuid, endpoint_device_request, opts = {})
  data, _status_code, _headers = endpoints_devices_update_with_http_info(device_uuid, endpoint_device_request, opts)
  data
end

#endpoints_devices_update_with_http_info(device_uuid, endpoint_device_request, opts = {}) ⇒ Array<(EndpointDevice, Integer, Hash)>

Mixin to add a used_by endpoint to return a list of all objects using this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Returns:

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

    EndpointDevice data, response status code and response headers



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

def endpoints_devices_update_with_http_info(device_uuid, endpoint_device_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_devices_update ...'
  end
  # verify the required parameter 'device_uuid' is set
  if @api_client.config.client_side_validation && device_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'device_uuid' when calling EndpointsApi.endpoints_devices_update"
  end
  # verify the required parameter 'endpoint_device_request' is set
  if @api_client.config.client_side_validation && endpoint_device_request.nil?
    fail ArgumentError, "Missing the required parameter 'endpoint_device_request' when calling EndpointsApi.endpoints_devices_update"
  end
  # resource path
  local_var_path = '/endpoints/devices/{device_uuid}/'.sub('{device_uuid}', CGI.escape(device_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(endpoint_device_request)

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

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

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

#endpoints_devices_used_by_list(device_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Returns:



3139
3140
3141
3142
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3139

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

#endpoints_devices_used_by_list_with_http_info(device_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • device_uuid (String) —

    A UUID string identifying this Device.

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

    the optional parameters

Returns:

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

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



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

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

#endpoints_fleet_connectors_create(fleet_connector_request, opts = {}) ⇒ FleetConnector

FleetConnector Viewset

Parameters:

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

    the optional parameters

Returns:



3200
3201
3202
3203
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3200

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

#endpoints_fleet_connectors_create_with_http_info(fleet_connector_request, opts = {}) ⇒ Array<(FleetConnector, Integer, Hash)>

FleetConnector Viewset

Parameters:

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

    the optional parameters

Returns:

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

    FleetConnector data, response status code and response headers



3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3209

def endpoints_fleet_connectors_create_with_http_info(fleet_connector_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_fleet_connectors_create ...'
  end
  # verify the required parameter 'fleet_connector_request' is set
  if @api_client.config.client_side_validation && fleet_connector_request.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_connector_request' when calling EndpointsApi.endpoints_fleet_connectors_create"
  end
  # resource path
  local_var_path = '/endpoints/fleet/connectors/'

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

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

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

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

#endpoints_fleet_connectors_destroy(connector_uuid, opts = {}) ⇒ nil

FleetConnector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Returns:

  • (nil) 


3266
3267
3268
3269
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3266

def endpoints_fleet_connectors_destroy(connector_uuid, opts = {})
  endpoints_fleet_connectors_destroy_with_http_info(connector_uuid, opts)
  nil
end

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

FleetConnector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3275

def endpoints_fleet_connectors_destroy_with_http_info(connector_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_fleet_connectors_destroy ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_fleet_connectors_destroy"
  end
  # resource path
  local_var_path = '/endpoints/fleet/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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 => :"EndpointsApi.endpoints_fleet_connectors_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: EndpointsApi#endpoints_fleet_connectors_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#endpoints_fleet_connectors_list(opts = {}) ⇒ PaginatedFleetConnectorList

FleetConnector Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:



3331
3332
3333
3334
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3331

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

#endpoints_fleet_connectors_list_with_http_info(opts = {}) ⇒ Array<(PaginatedFleetConnectorList, Integer, Hash)>

FleetConnector Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:

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

    PaginatedFleetConnectorList data, response status code and response headers



3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3344

def endpoints_fleet_connectors_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_fleet_connectors_list ...'
  end
  # resource path
  local_var_path = '/endpoints/fleet/connectors/'

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

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

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

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

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

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

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

#endpoints_fleet_connectors_partial_update(connector_uuid, opts = {}) ⇒ FleetConnector

FleetConnector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Options Hash (opts):

Returns:



3398
3399
3400
3401
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3398

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

#endpoints_fleet_connectors_partial_update_with_http_info(connector_uuid, opts = {}) ⇒ Array<(FleetConnector, Integer, Hash)>

FleetConnector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    FleetConnector data, response status code and response headers



3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3408

def endpoints_fleet_connectors_partial_update_with_http_info(connector_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_fleet_connectors_partial_update ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_fleet_connectors_partial_update"
  end
  # resource path
  local_var_path = '/endpoints/fleet/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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_fleet_connector_request'])

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

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

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

#endpoints_fleet_connectors_retrieve(connector_uuid, opts = {}) ⇒ FleetConnector

FleetConnector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Returns:



3465
3466
3467
3468
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3465

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

#endpoints_fleet_connectors_retrieve_with_http_info(connector_uuid, opts = {}) ⇒ Array<(FleetConnector, Integer, Hash)>

FleetConnector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Returns:

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

    FleetConnector data, response status code and response headers



3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3474

def endpoints_fleet_connectors_retrieve_with_http_info(connector_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_fleet_connectors_retrieve ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_fleet_connectors_retrieve"
  end
  # resource path
  local_var_path = '/endpoints/fleet/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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] || 'FleetConnector'

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

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

#endpoints_fleet_connectors_update(connector_uuid, fleet_connector_request, opts = {}) ⇒ FleetConnector

FleetConnector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Returns:



3527
3528
3529
3530
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3527

def endpoints_fleet_connectors_update(connector_uuid, fleet_connector_request, opts = {})
  data, _status_code, _headers = endpoints_fleet_connectors_update_with_http_info(connector_uuid, fleet_connector_request, opts)
  data
end

#endpoints_fleet_connectors_update_with_http_info(connector_uuid, fleet_connector_request, opts = {}) ⇒ Array<(FleetConnector, Integer, Hash)>

FleetConnector Viewset

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Returns:

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

    FleetConnector data, response status code and response headers



3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3537

def endpoints_fleet_connectors_update_with_http_info(connector_uuid, fleet_connector_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_fleet_connectors_update ...'
  end
  # verify the required parameter 'connector_uuid' is set
  if @api_client.config.client_side_validation && connector_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'connector_uuid' when calling EndpointsApi.endpoints_fleet_connectors_update"
  end
  # verify the required parameter 'fleet_connector_request' is set
  if @api_client.config.client_side_validation && fleet_connector_request.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_connector_request' when calling EndpointsApi.endpoints_fleet_connectors_update"
  end
  # resource path
  local_var_path = '/endpoints/fleet/connectors/{connector_uuid}/'.sub('{connector_uuid}', CGI.escape(connector_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(fleet_connector_request)

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

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

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

#endpoints_fleet_connectors_used_by_list(connector_uuid, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Returns:



3598
3599
3600
3601
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3598

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

#endpoints_fleet_connectors_used_by_list_with_http_info(connector_uuid, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • connector_uuid (String) —

    A UUID string identifying this Fleet Connector.

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

    the optional parameters

Returns:

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

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



3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
 
# File 'lib/authentik/api/api/endpoints_api.rb', line 3607

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