Class: Authentik::Api::RequestsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RequestsApi

Returns a new instance of RequestsApi.



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

def api_client
  @api_client
end

Instance Method Details

#requests_grant_requests_agent_create(agent_grant_request_create_request, opts = {}) ⇒ AgentGrantRequestCreated

Delegate access an agent's owner already holds to the agent, time-boxed. Unlike create this persists the request directly instead of returning a flow link -- an agent authenticates with an API token and has no browser to run a flow in, so no justification is ever collected. That is why the agent may only ask for what its owner already has: the owner's approval is then the whole decision, and no reviewer is asked to judge a request with nothing in it. The returned fulfill_url is what the agent hands to its owner so they can act on it.

Parameters:

Returns:



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

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

#requests_grant_requests_agent_create_with_http_info(agent_grant_request_create_request, opts = {}) ⇒ Array<(AgentGrantRequestCreated, Integer, Hash)>

Delegate access an agent's owner already holds to the agent, time-boxed. Unlike `create` this persists the request directly instead of returning a flow link -- an agent authenticates with an API token and has no browser to run a flow in, so no justification is ever collected. That is why the agent may only ask for what its owner already has: the owner's approval is then the whole decision, and no reviewer is asked to judge a request with nothing in it. The returned `fulfill_url` is what the agent hands to its owner so they can act on it.

Parameters:

Returns:

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

    AgentGrantRequestCreated data, response status code and response headers



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

def requests_grant_requests_agent_create_with_http_info(agent_grant_request_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_grant_requests_agent_create ...'
  end
  # verify the required parameter 'agent_grant_request_create_request' is set
  if @api_client.config.client_side_validation && agent_grant_request_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'agent_grant_request_create_request' when calling RequestsApi.requests_grant_requests_agent_create"
  end
  # resource path
  local_var_path = '/requests/grant-requests/agent/'

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

  # header parameters
  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_grant_request_create_request)

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

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

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

#requests_grant_requests_create(grant_request_create_request, opts = {}) ⇒ Link

Parameters:

Returns:



85
86
87
88
 
# File 'lib/authentik/api/api/requests_api.rb', line 85

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

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

Returns Link data, response status code and response headers.

Parameters:

Returns:

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

    Link data, response status code and response headers



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

def requests_grant_requests_create_with_http_info(grant_request_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_grant_requests_create ...'
  end
  # verify the required parameter 'grant_request_create_request' is set
  if @api_client.config.client_side_validation && grant_request_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'grant_request_create_request' when calling RequestsApi.requests_grant_requests_create"
  end
  # resource path
  local_var_path = '/requests/grant-requests/'

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

  # header parameters
  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(grant_request_create_request)

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

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

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

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Grant Request.

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

    the optional parameters

Returns:

  • (nil) 


149
150
151
152
 
# File 'lib/authentik/api/api/requests_api.rb', line 149

def requests_grant_requests_destroy(uuid, opts = {})
  requests_grant_requests_destroy_with_http_info(uuid, opts)
  nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • uuid (String) —

    A UUID string identifying this Grant Request.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Grant Request.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


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

def requests_grant_requests_fulfill_partial_update(uuid, opts = {})
  requests_grant_requests_fulfill_partial_update_with_http_info(uuid, opts)
  nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • uuid (String) —

    A UUID string identifying this Grant Request.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

def requests_grant_requests_fulfill_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_grant_requests_fulfill_partial_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_grant_requests_fulfill_partial_update"
  end
  # resource path
  local_var_path = '/requests/grant-requests/{uuid}/fulfill/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#requests_grant_requests_list(opts = {}) ⇒ PaginatedGrantRequestList

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :agent_owner (Integer)
  • :created_by (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.

  • :search (String) —

    A search term.

  • :status (RequestStatus)

Returns:



280
281
282
283
 
# File 'lib/authentik/api/api/requests_api.rb', line 280

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

#requests_grant_requests_list_with_http_info(opts = {}) ⇒ Array<(PaginatedGrantRequestList, Integer, Hash)>

Returns PaginatedGrantRequestList data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :agent_owner (Integer)
  • :created_by (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.

  • :search (String) —

    A search term.

  • :status (RequestStatus)

Returns:

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

    PaginatedGrantRequestList data, response status code and response headers



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/authentik/api/api/requests_api.rb', line 294

def requests_grant_requests_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_grant_requests_list ...'
  end
  # resource path
  local_var_path = '/requests/grant-requests/'

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

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

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

#requests_grant_requests_pending_review_list(opts = {}) ⇒ PaginatedGrantRequestList

List pending grant requests the current user is eligible to review.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :agent_owner (Integer)
  • :created_by (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.

  • :search (String) —

    A search term.

  • :status (RequestStatus)

Returns:



355
356
357
358
 
# File 'lib/authentik/api/api/requests_api.rb', line 355

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

#requests_grant_requests_pending_review_list_with_http_info(opts = {}) ⇒ Array<(PaginatedGrantRequestList, Integer, Hash)>

List pending grant requests the current user is eligible to review.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :agent_owner (Integer)
  • :created_by (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.

  • :search (String) —

    A search term.

  • :status (RequestStatus)

Returns:

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

    PaginatedGrantRequestList data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/authentik/api/api/requests_api.rb', line 370

def requests_grant_requests_pending_review_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_grant_requests_pending_review_list ...'
  end
  # resource path
  local_var_path = '/requests/grant-requests/pending_review/'

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

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

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

#requests_grant_requests_retrieve(uuid, opts = {}) ⇒ GrantRequest

Parameters:

  • uuid (String) —

    A UUID string identifying this Grant Request.

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

    the optional parameters

Returns:



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

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

#requests_grant_requests_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(GrantRequest, Integer, Hash)>

Returns GrantRequest data, response status code and response headers.

Parameters:

  • uuid (String) —

    A UUID string identifying this Grant Request.

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

    the optional parameters

Returns:

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

    GrantRequest data, response status code and response headers



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/authentik/api/api/requests_api.rb', line 432

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

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

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

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

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

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

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

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

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

Immediately end an active grant. Available to the same reviewers who could approve it in the first place.

Parameters:

  • uuid (String) —

    A UUID string identifying this Grant Request.

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

    the optional parameters

Returns:

  • (nil) 


484
485
486
487
 
# File 'lib/authentik/api/api/requests_api.rb', line 484

def requests_grant_requests_revoke_destroy(uuid, opts = {})
  requests_grant_requests_revoke_destroy_with_http_info(uuid, opts)
  nil
end

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

Immediately end an active grant. Available to the same reviewers who could approve it in the first place.

Parameters:

  • uuid (String) —

    A UUID string identifying this Grant Request.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def requests_grant_requests_revoke_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_grant_requests_revoke_destroy ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_grant_requests_revoke_destroy"
  end
  # resource path
  local_var_path = '/requests/grant-requests/{uuid}/revoke/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#requests_rule_bindings_create(request_rule_binding_request, opts = {}) ⇒ RequestRuleBinding

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

Parameters:

Returns:



545
546
547
548
 
# File 'lib/authentik/api/api/requests_api.rb', line 545

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

#requests_rule_bindings_create_with_http_info(request_rule_binding_request, opts = {}) ⇒ Array<(RequestRuleBinding, Integer, Hash)>

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

Parameters:

Returns:

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

    RequestRuleBinding data, response status code and response headers



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

def requests_rule_bindings_create_with_http_info(request_rule_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_bindings_create ...'
  end
  # verify the required parameter 'request_rule_binding_request' is set
  if @api_client.config.client_side_validation && request_rule_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'request_rule_binding_request' when calling RequestsApi.requests_rule_bindings_create"
  end
  # resource path
  local_var_path = '/requests/rule-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(request_rule_binding_request)

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

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

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

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

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Returns:

  • (nil) 


611
612
613
614
 
# File 'lib/authentik/api/api/requests_api.rb', line 611

def requests_rule_bindings_destroy(uuid, opts = {})
  requests_rule_bindings_destroy_with_http_info(uuid, opts)
  nil
end

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

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def requests_rule_bindings_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_bindings_destroy ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_bindings_destroy"
  end
  # resource path
  local_var_path = '/requests/rule-bindings/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#requests_rule_bindings_list(opts = {}) ⇒ PaginatedRequestRuleBindingList

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

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

  • :rule (String)
  • :search (String) —

    A search term.

  • :target (String)

Returns:



677
678
679
680
 
# File 'lib/authentik/api/api/requests_api.rb', line 677

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

#requests_rule_bindings_list_with_http_info(opts = {}) ⇒ Array<(PaginatedRequestRuleBindingList, 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):

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

  • :rule (String)
  • :search (String) —

    A search term.

  • :target (String)

Returns:



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

def requests_rule_bindings_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_bindings_list ...'
  end
  # resource path
  local_var_path = '/requests/rule-bindings/'

  # 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[:'rule'] = opts[:'rule'] if !opts[:'rule'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'target'] = opts[:'target'] if !opts[:'target'].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] || 'PaginatedRequestRuleBindingList'

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

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

#requests_rule_bindings_partial_update(uuid, opts = {}) ⇒ RequestRuleBinding

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Options Hash (opts):

Returns:



746
747
748
749
 
# File 'lib/authentik/api/api/requests_api.rb', line 746

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

#requests_rule_bindings_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(RequestRuleBinding, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RequestRuleBinding data, response status code and response headers



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

def requests_rule_bindings_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_bindings_partial_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_bindings_partial_update"
  end
  # resource path
  local_var_path = '/requests/rule-bindings/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#requests_rule_bindings_retrieve(uuid, opts = {}) ⇒ RequestRuleBinding

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Returns:



813
814
815
816
 
# File 'lib/authentik/api/api/requests_api.rb', line 813

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

#requests_rule_bindings_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(RequestRuleBinding, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Returns:

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

    RequestRuleBinding data, response status code and response headers



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/authentik/api/api/requests_api.rb', line 822

def requests_rule_bindings_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_bindings_retrieve ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_bindings_retrieve"
  end
  # resource path
  local_var_path = '/requests/rule-bindings/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#requests_rule_bindings_update(uuid, request_rule_binding_request, opts = {}) ⇒ RequestRuleBinding

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Returns:



875
876
877
878
 
# File 'lib/authentik/api/api/requests_api.rb', line 875

def requests_rule_bindings_update(uuid, request_rule_binding_request, opts = {})
  data, _status_code, _headers = requests_rule_bindings_update_with_http_info(uuid, request_rule_binding_request, opts)
  data
end

#requests_rule_bindings_update_with_http_info(uuid, request_rule_binding_request, opts = {}) ⇒ Array<(RequestRuleBinding, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Returns:

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

    RequestRuleBinding data, response status code and response headers



885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/authentik/api/api/requests_api.rb', line 885

def requests_rule_bindings_update_with_http_info(uuid, request_rule_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_bindings_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_bindings_update"
  end
  # verify the required parameter 'request_rule_binding_request' is set
  if @api_client.config.client_side_validation && request_rule_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'request_rule_binding_request' when calling RequestsApi.requests_rule_bindings_update"
  end
  # resource path
  local_var_path = '/requests/rule-bindings/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Returns:



946
947
948
949
 
# File 'lib/authentik/api/api/requests_api.rb', line 946

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Binding.

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/authentik/api/api/requests_api.rb', line 955

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

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

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

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

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

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

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

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

#requests_rule_child_bindings_create(request_rule_child_binding_request, opts = {}) ⇒ RequestRuleChildBinding

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

Parameters:

Returns:



1007
1008
1009
1010
 
# File 'lib/authentik/api/api/requests_api.rb', line 1007

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

#requests_rule_child_bindings_create_with_http_info(request_rule_child_binding_request, opts = {}) ⇒ Array<(RequestRuleChildBinding, Integer, Hash)>

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

Parameters:

Returns:

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

    RequestRuleChildBinding data, response status code and response headers



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
 
# File 'lib/authentik/api/api/requests_api.rb', line 1016

def requests_rule_child_bindings_create_with_http_info(request_rule_child_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_child_bindings_create ...'
  end
  # verify the required parameter 'request_rule_child_binding_request' is set
  if @api_client.config.client_side_validation && request_rule_child_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'request_rule_child_binding_request' when calling RequestsApi.requests_rule_child_bindings_create"
  end
  # resource path
  local_var_path = '/requests/rule-child-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(request_rule_child_binding_request)

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

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

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

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

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Returns:

  • (nil) 


1073
1074
1075
1076
 
# File 'lib/authentik/api/api/requests_api.rb', line 1073

def requests_rule_child_bindings_destroy(uuid, opts = {})
  requests_rule_child_bindings_destroy_with_http_info(uuid, opts)
  nil
end

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

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'lib/authentik/api/api/requests_api.rb', line 1082

def requests_rule_child_bindings_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_child_bindings_destroy ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_child_bindings_destroy"
  end
  # resource path
  local_var_path = '/requests/rule-child-bindings/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#requests_rule_child_bindings_list(opts = {}) ⇒ PaginatedRequestRuleChildBindingList

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

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

  • :target (String)

Returns:



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

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

#requests_rule_child_bindings_list_with_http_info(opts = {}) ⇒ Array<(PaginatedRequestRuleChildBindingList, 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):

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

  • :target (String)

Returns:



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

def requests_rule_child_bindings_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_child_bindings_list ...'
  end
  # resource path
  local_var_path = '/requests/rule-child-bindings/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'binding'] = opts[:'binding'] if !opts[:'binding'].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[:'target'] = opts[:'target'] if !opts[:'target'].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] || 'PaginatedRequestRuleChildBindingList'

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

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

#requests_rule_child_bindings_partial_update(uuid, opts = {}) ⇒ RequestRuleChildBinding

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Options Hash (opts):

Returns:



1208
1209
1210
1211
 
# File 'lib/authentik/api/api/requests_api.rb', line 1208

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

#requests_rule_child_bindings_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(RequestRuleChildBinding, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RequestRuleChildBinding data, response status code and response headers



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

def requests_rule_child_bindings_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_child_bindings_partial_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_child_bindings_partial_update"
  end
  # resource path
  local_var_path = '/requests/rule-child-bindings/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#requests_rule_child_bindings_retrieve(uuid, opts = {}) ⇒ RequestRuleChildBinding

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Returns:



1275
1276
1277
1278
 
# File 'lib/authentik/api/api/requests_api.rb', line 1275

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

#requests_rule_child_bindings_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(RequestRuleChildBinding, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Returns:

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

    RequestRuleChildBinding data, response status code and response headers



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

def requests_rule_child_bindings_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_child_bindings_retrieve ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_child_bindings_retrieve"
  end
  # resource path
  local_var_path = '/requests/rule-child-bindings/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#requests_rule_child_bindings_update(uuid, request_rule_child_binding_request, opts = {}) ⇒ RequestRuleChildBinding

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Returns:



1337
1338
1339
1340
 
# File 'lib/authentik/api/api/requests_api.rb', line 1337

def requests_rule_child_bindings_update(uuid, request_rule_child_binding_request, opts = {})
  data, _status_code, _headers = requests_rule_child_bindings_update_with_http_info(uuid, request_rule_child_binding_request, opts)
  data
end

#requests_rule_child_bindings_update_with_http_info(uuid, request_rule_child_binding_request, opts = {}) ⇒ Array<(RequestRuleChildBinding, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Returns:

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

    RequestRuleChildBinding data, response status code and response headers



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

def requests_rule_child_bindings_update_with_http_info(uuid, request_rule_child_binding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_child_bindings_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_child_bindings_update"
  end
  # verify the required parameter 'request_rule_child_binding_request' is set
  if @api_client.config.client_side_validation && request_rule_child_binding_request.nil?
    fail ArgumentError, "Missing the required parameter 'request_rule_child_binding_request' when calling RequestsApi.requests_rule_child_bindings_update"
  end
  # resource path
  local_var_path = '/requests/rule-child-bindings/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Returns:



1408
1409
1410
1411
 
# File 'lib/authentik/api/api/requests_api.rb', line 1408

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule Child Binding.

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



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

def requests_rule_child_bindings_used_by_list_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rule_child_bindings_used_by_list ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RequestsApi.requests_rule_child_bindings_used_by_list"
  end
  # resource path
  local_var_path = '/requests/rule-child-bindings/{uuid}/used_by/'.sub('{uuid}', CGI.escape(uuid.to_s))

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

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

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

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

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

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

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

#requests_rules_create(request_rule_request, opts = {}) ⇒ RequestRule

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

Parameters:

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

    the optional parameters

Returns:



1469
1470
1471
1472
 
# File 'lib/authentik/api/api/requests_api.rb', line 1469

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

#requests_rules_create_with_http_info(request_rule_request, opts = {}) ⇒ Array<(RequestRule, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Returns:

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

    RequestRule data, response status code and response headers



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

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

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

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

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

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

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

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

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

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

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

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Returns:

  • (nil) 


1535
1536
1537
1538
 
# File 'lib/authentik/api/api/requests_api.rb', line 1535

def requests_rules_destroy(uuid, opts = {})
  requests_rules_destroy_with_http_info(uuid, opts)
  nil
end

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

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#requests_rules_list(opts = {}) ⇒ PaginatedRequestRuleList

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

  • :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)
  • :request_flow__slug (String)
  • :search (String) —

    A search term.

Returns:



1602
1603
1604
1605
 
# File 'lib/authentik/api/api/requests_api.rb', line 1602

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

#requests_rules_list_with_http_info(opts = {}) ⇒ Array<(PaginatedRequestRuleList, 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):

  • :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)
  • :request_flow__slug (String)
  • :search (String) —

    A search term.

Returns:

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

    PaginatedRequestRuleList data, response status code and response headers



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

def requests_rules_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_rules_list ...'
  end
  # resource path
  local_var_path = '/requests/rules/'

  # 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[:'request_flow__slug'] = opts[:'request_flow__slug'] if !opts[:'request_flow__slug'].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] || 'PaginatedRequestRuleList'

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

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

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

#requests_rules_partial_update(uuid, opts = {}) ⇒ RequestRule

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Options Hash (opts):

Returns:



1673
1674
1675
1676
 
# File 'lib/authentik/api/api/requests_api.rb', line 1673

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

#requests_rules_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(RequestRule, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RequestRule data, response status code and response headers



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

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

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

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

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

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

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

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

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

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

#requests_rules_retrieve(uuid, opts = {}) ⇒ RequestRule

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Returns:



1740
1741
1742
1743
 
# File 'lib/authentik/api/api/requests_api.rb', line 1740

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

#requests_rules_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(RequestRule, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Returns:

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

    RequestRule data, response status code and response headers



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

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

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

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

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

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

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

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

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

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

#requests_rules_update(uuid, request_rule_request, opts = {}) ⇒ RequestRule

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Returns:



1802
1803
1804
1805
 
# File 'lib/authentik/api/api/requests_api.rb', line 1802

def requests_rules_update(uuid, request_rule_request, opts = {})
  data, _status_code, _headers = requests_rules_update_with_http_info(uuid, request_rule_request, opts)
  data
end

#requests_rules_update_with_http_info(uuid, request_rule_request, opts = {}) ⇒ Array<(RequestRule, Integer, Hash)>

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

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Returns:

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

    RequestRule data, response status code and response headers



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

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

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

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

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

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

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

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

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

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Returns:



1873
1874
1875
1876
 
# File 'lib/authentik/api/api/requests_api.rb', line 1873

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

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

Get a list of all objects that use this object

Parameters:

  • uuid (String) —

    A UUID string identifying this Request Rule.

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



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

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

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

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

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

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

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

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

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

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