Class: Authentik::Api::RbacApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RbacApi

Returns a new instance of RbacApi.



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

def api_client
  @api_client
end

Instance Method Details

#rbac_initial_permissions_create(initial_permissions_request, opts = {}) ⇒ InitialPermissions

InitialPermissions viewset

Parameters:

Returns:



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

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

#rbac_initial_permissions_create_with_http_info(initial_permissions_request, opts = {}) ⇒ Array<(InitialPermissions, Integer, Hash)>

InitialPermissions viewset

Parameters:

Returns:

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

    InitialPermissions 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/rbac_api.rb', line 29

def rbac_initial_permissions_create_with_http_info(initial_permissions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_initial_permissions_create ...'
  end
  # verify the required parameter 'initial_permissions_request' is set
  if @api_client.config.client_side_validation && initial_permissions_request.nil?
    fail ArgumentError, "Missing the required parameter 'initial_permissions_request' when calling RbacApi.rbac_initial_permissions_create"
  end
  # resource path
  local_var_path = '/rbac/initial_permissions/'

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

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

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

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

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

InitialPermissions viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Returns:

  • (nil) 


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

def rbac_initial_permissions_destroy(id, opts = {})
  rbac_initial_permissions_destroy_with_http_info(id, opts)
  nil
end

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

InitialPermissions viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def rbac_initial_permissions_destroy_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_initial_permissions_destroy ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RbacApi.rbac_initial_permissions_destroy"
  end
  # resource path
  local_var_path = '/rbac/initial_permissions/{id}/'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#rbac_initial_permissions_list(opts = {}) ⇒ PaginatedInitialPermissionsList

InitialPermissions viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:



151
152
153
154
 
# File 'lib/authentik/api/api/rbac_api.rb', line 151

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

#rbac_initial_permissions_list_with_http_info(opts = {}) ⇒ Array<(PaginatedInitialPermissionsList, Integer, Hash)>

InitialPermissions viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:



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
204
205
206
207
208
209
210
211
 
# File 'lib/authentik/api/api/rbac_api.rb', line 164

def rbac_initial_permissions_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_initial_permissions_list ...'
  end
  # resource path
  local_var_path = '/rbac/initial_permissions/'

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

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

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

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

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

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

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

#rbac_initial_permissions_partial_update(id, opts = {}) ⇒ InitialPermissions

InitialPermissions viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Options Hash (opts):

Returns:



218
219
220
221
 
# File 'lib/authentik/api/api/rbac_api.rb', line 218

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

#rbac_initial_permissions_partial_update_with_http_info(id, opts = {}) ⇒ Array<(InitialPermissions, Integer, Hash)>

InitialPermissions viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InitialPermissions data, response status code and response headers



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
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/authentik/api/api/rbac_api.rb', line 228

def rbac_initial_permissions_partial_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_initial_permissions_partial_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RbacApi.rbac_initial_permissions_partial_update"
  end
  # resource path
  local_var_path = '/rbac/initial_permissions/{id}/'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

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

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

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

#rbac_initial_permissions_retrieve(id, opts = {}) ⇒ InitialPermissions

InitialPermissions viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Returns:



285
286
287
288
 
# File 'lib/authentik/api/api/rbac_api.rb', line 285

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

#rbac_initial_permissions_retrieve_with_http_info(id, opts = {}) ⇒ Array<(InitialPermissions, Integer, Hash)>

InitialPermissions viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Returns:

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

    InitialPermissions 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
 
# File 'lib/authentik/api/api/rbac_api.rb', line 294

def rbac_initial_permissions_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_initial_permissions_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RbacApi.rbac_initial_permissions_retrieve"
  end
  # resource path
  local_var_path = '/rbac/initial_permissions/{id}/'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

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

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

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

#rbac_initial_permissions_update(id, initial_permissions_request, opts = {}) ⇒ InitialPermissions

InitialPermissions viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Returns:



347
348
349
350
 
# File 'lib/authentik/api/api/rbac_api.rb', line 347

def rbac_initial_permissions_update(id, initial_permissions_request, opts = {})
  data, _status_code, _headers = rbac_initial_permissions_update_with_http_info(id, initial_permissions_request, opts)
  data
end

#rbac_initial_permissions_update_with_http_info(id, initial_permissions_request, opts = {}) ⇒ Array<(InitialPermissions, Integer, Hash)>

InitialPermissions viewset

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Returns:

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

    InitialPermissions data, response status code and response headers



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/authentik/api/api/rbac_api.rb', line 357

def rbac_initial_permissions_update_with_http_info(id, initial_permissions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_initial_permissions_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RbacApi.rbac_initial_permissions_update"
  end
  # verify the required parameter 'initial_permissions_request' is set
  if @api_client.config.client_side_validation && initial_permissions_request.nil?
    fail ArgumentError, "Missing the required parameter 'initial_permissions_request' when calling RbacApi.rbac_initial_permissions_update"
  end
  # resource path
  local_var_path = '/rbac/initial_permissions/{id}/'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

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

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

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

#rbac_initial_permissions_used_by_list(id, opts = {}) ⇒ Array<UsedBy>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Returns:



418
419
420
421
 
# File 'lib/authentik/api/api/rbac_api.rb', line 418

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

#rbac_initial_permissions_used_by_list_with_http_info(id, opts = {}) ⇒ Array<(Array<UsedBy>, Integer, Hash)>

Get a list of all objects that use this object

Parameters:

  • id (Integer) —

    A unique integer value identifying this Initial Permissions.

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

    the optional parameters

Returns:

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

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



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

def rbac_initial_permissions_used_by_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_initial_permissions_used_by_list ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RbacApi.rbac_initial_permissions_used_by_list"
  end
  # resource path
  local_var_path = '/rbac/initial_permissions/{id}/used_by/'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

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

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

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

#rbac_permissions_assigned_by_roles_assign(uuid, permission_assign_request, opts = {}) ⇒ Array<PermissionAssignResult>

Assign permission(s) to role. When ‘object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:



480
481
482
483
 
# File 'lib/authentik/api/api/rbac_api.rb', line 480

def rbac_permissions_assigned_by_roles_assign(uuid, permission_assign_request, opts = {})
  data, _status_code, _headers = rbac_permissions_assigned_by_roles_assign_with_http_info(uuid, permission_assign_request, opts)
  data
end

#rbac_permissions_assigned_by_roles_assign_with_http_info(uuid, permission_assign_request, opts = {}) ⇒ Array<(Array<PermissionAssignResult>, Integer, Hash)>

Assign permission(s) to role. When &#x60;object_pk&#x60; is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

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

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



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

def rbac_permissions_assigned_by_roles_assign_with_http_info(uuid, permission_assign_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_permissions_assigned_by_roles_assign ...'
  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 RbacApi.rbac_permissions_assigned_by_roles_assign"
  end
  # verify the required parameter 'permission_assign_request' is set
  if @api_client.config.client_side_validation && permission_assign_request.nil?
    fail ArgumentError, "Missing the required parameter 'permission_assign_request' when calling RbacApi.rbac_permissions_assigned_by_roles_assign"
  end
  # resource path
  local_var_path = '/rbac/permissions/assigned_by_roles/{uuid}/assign/'.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(permission_assign_request)

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

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

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

#rbac_permissions_assigned_by_roles_list(model, opts = {}) ⇒ PaginatedRoleAssignedObjectPermissionList

Get assigned object permissions for a single object

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :object_pk (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:



556
557
558
559
 
# File 'lib/authentik/api/api/rbac_api.rb', line 556

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

#rbac_permissions_assigned_by_roles_list_with_http_info(model, opts = {}) ⇒ Array<(PaginatedRoleAssignedObjectPermissionList, Integer, Hash)>

Get assigned object permissions for a single object

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :object_pk (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

Returns:



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/authentik/api/api/rbac_api.rb', line 570

def rbac_permissions_assigned_by_roles_list_with_http_info(model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_permissions_assigned_by_roles_list ...'
  end
  # verify the required parameter 'model' is set
  if @api_client.config.client_side_validation && model.nil?
    fail ArgumentError, "Missing the required parameter 'model' when calling RbacApi.rbac_permissions_assigned_by_roles_list"
  end
  # verify enum value
  allowable_values = ["authentik_blueprints.blueprintinstance", "authentik_brands.brand", "authentik_core.application", "authentik_core.applicationentitlement", "authentik_core.group", "authentik_core.token", "authentik_core.user", "authentik_crypto.certificatekeypair", "authentik_endpoints.deviceaccessgroup", "authentik_endpoints.deviceuserbinding", "authentik_endpoints.endpointstage", "authentik_endpoints_connectors_agent.agentconnector", "authentik_endpoints_connectors_agent.agentdeviceuserbinding", "authentik_endpoints_connectors_agent.enrollmenttoken", "authentik_endpoints_connectors_fleet.fleetconnector", "authentik_enterprise.license", "authentik_events.event", "authentik_events.notification", "authentik_events.notificationrule", "authentik_events.notificationtransport", "authentik_events.notificationwebhookmapping", "authentik_flows.flow", "authentik_flows.flowstagebinding", "authentik_lifecycle.lifecycleiteration", "authentik_lifecycle.lifecyclerule", "authentik_lifecycle.review", "authentik_outposts.dockerserviceconnection", "authentik_outposts.kubernetesserviceconnection", "authentik_outposts.outpost", "authentik_policies.policybinding", "authentik_policies_dummy.dummypolicy", "authentik_policies_event_matcher.eventmatcherpolicy", "authentik_policies_expiry.passwordexpirypolicy", "authentik_policies_expression.expressionpolicy", "authentik_policies_geoip.geoippolicy", "authentik_policies_password.passwordpolicy", "authentik_policies_reputation.reputationpolicy", "authentik_policies_unique_password.uniquepasswordpolicy", "authentik_providers_google_workspace.googleworkspaceprovider", "authentik_providers_google_workspace.googleworkspaceprovidermapping", "authentik_providers_ldap.ldapprovider", "authentik_providers_microsoft_entra.microsoftentraprovider", "authentik_providers_microsoft_entra.microsoftentraprovidermapping", "authentik_providers_oauth2.oauth2provider", "authentik_providers_oauth2.scopemapping", "authentik_providers_proxy.proxyprovider", "authentik_providers_rac.endpoint", "authentik_providers_rac.racpropertymapping", "authentik_providers_rac.racprovider", "authentik_providers_radius.radiusprovider", "authentik_providers_radius.radiusproviderpropertymapping", "authentik_providers_saml.samlpropertymapping", "authentik_providers_saml.samlprovider", "authentik_providers_scim.scimmapping", "authentik_providers_scim.scimprovider", "authentik_providers_ssf.ssfprovider", "authentik_providers_ws_federation.wsfederationprovider", "authentik_rbac.initialpermissions", "authentik_rbac.role", "authentik_reports.dataexport", "authentik_sources_kerberos.groupkerberossourceconnection", "authentik_sources_kerberos.kerberossource", "authentik_sources_kerberos.kerberossourcepropertymapping", "authentik_sources_kerberos.userkerberossourceconnection", "authentik_sources_ldap.groupldapsourceconnection", "authentik_sources_ldap.ldapsource", "authentik_sources_ldap.ldapsourcepropertymapping", "authentik_sources_ldap.userldapsourceconnection", "authentik_sources_oauth.groupoauthsourceconnection", "authentik_sources_oauth.oauthsource", "authentik_sources_oauth.oauthsourcepropertymapping", "authentik_sources_oauth.useroauthsourceconnection", "authentik_sources_plex.groupplexsourceconnection", "authentik_sources_plex.plexsource", "authentik_sources_plex.plexsourcepropertymapping", "authentik_sources_plex.userplexsourceconnection", "authentik_sources_saml.groupsamlsourceconnection", "authentik_sources_saml.samlsource", "authentik_sources_saml.samlsourcepropertymapping", "authentik_sources_saml.usersamlsourceconnection", "authentik_sources_scim.scimsource", "authentik_sources_scim.scimsourcepropertymapping", "authentik_sources_telegram.grouptelegramsourceconnection", "authentik_sources_telegram.telegramsource", "authentik_sources_telegram.telegramsourcepropertymapping", "authentik_sources_telegram.usertelegramsourceconnection", "authentik_stages_authenticator_duo.authenticatorduostage", "authentik_stages_authenticator_duo.duodevice", "authentik_stages_authenticator_email.authenticatoremailstage", "authentik_stages_authenticator_email.emaildevice", "authentik_stages_authenticator_endpoint_gdtc.authenticatorendpointgdtcstage", "authentik_stages_authenticator_sms.authenticatorsmsstage", "authentik_stages_authenticator_sms.smsdevice", "authentik_stages_authenticator_static.authenticatorstaticstage", "authentik_stages_authenticator_static.staticdevice", "authentik_stages_authenticator_totp.authenticatortotpstage", "authentik_stages_authenticator_totp.totpdevice", "authentik_stages_authenticator_validate.authenticatorvalidatestage", "authentik_stages_authenticator_webauthn.authenticatorwebauthnstage", "authentik_stages_authenticator_webauthn.webauthndevice", "authentik_stages_captcha.captchastage", "authentik_stages_consent.consentstage", "authentik_stages_deny.denystage", "authentik_stages_dummy.dummystage", "authentik_stages_email.emailstage", "authentik_stages_identification.identificationstage", "authentik_stages_invitation.invitation", "authentik_stages_invitation.invitationstage", "authentik_stages_mtls.mutualtlsstage", "authentik_stages_password.passwordstage", "authentik_stages_prompt.prompt", "authentik_stages_prompt.promptstage", "authentik_stages_redirect.redirectstage", "authentik_stages_source.sourcestage", "authentik_stages_user_delete.userdeletestage", "authentik_stages_user_login.userloginstage", "authentik_stages_user_logout.userlogoutstage", "authentik_stages_user_write.userwritestage", "authentik_tasks_schedules.schedule", "authentik_tenants.domain"]
  if @api_client.config.client_side_validation && !allowable_values.include?(model)
    fail ArgumentError, "invalid value for \"model\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/rbac/permissions/assigned_by_roles/'

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

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

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

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

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

Unassign permission(s) to role. When ‘object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


634
635
636
637
 
# File 'lib/authentik/api/api/rbac_api.rb', line 634

def rbac_permissions_assigned_by_roles_unassign_partial_update(uuid, opts = {})
  rbac_permissions_assigned_by_roles_unassign_partial_update_with_http_info(uuid, opts)
  nil
end

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

Unassign permission(s) to role. When &#x60;object_pk&#x60; is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/authentik/api/api/rbac_api.rb', line 644

def rbac_permissions_assigned_by_roles_unassign_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_permissions_assigned_by_roles_unassign_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 RbacApi.rbac_permissions_assigned_by_roles_unassign_partial_update"
  end
  # resource path
  local_var_path = '/rbac/permissions/assigned_by_roles/{uuid}/unassign/'.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_permission_assign_request'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#rbac_permissions_list(opts = {}) ⇒ PaginatedPermissionList

Read-only list of all permissions, filterable by model and app

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :codename (String)
  • :content_type__app_label (String)
  • :content_type__model (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.

  • :role (String)
  • :search (String) —

    A search term.

Returns:



708
709
710
711
 
# File 'lib/authentik/api/api/rbac_api.rb', line 708

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

#rbac_permissions_list_with_http_info(opts = {}) ⇒ Array<(PaginatedPermissionList, Integer, Hash)>

Read-only list of all permissions, filterable by model and app

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :codename (String)
  • :content_type__app_label (String)
  • :content_type__model (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.

  • :role (String)
  • :search (String) —

    A search term.

Returns:

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

    PaginatedPermissionList data, response status code and response headers



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/authentik/api/api/rbac_api.rb', line 724

def rbac_permissions_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_permissions_list ...'
  end
  # resource path
  local_var_path = '/rbac/permissions/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'codename'] = opts[:'codename'] if !opts[:'codename'].nil?
  query_params[:'content_type__app_label'] = opts[:'content_type__app_label'] if !opts[:'content_type__app_label'].nil?
  query_params[:'content_type__model'] = opts[:'content_type__model'] if !opts[:'content_type__model'].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[:'role'] = opts[:'role'] if !opts[:'role'].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] || 'PaginatedPermissionList'

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

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

#rbac_permissions_retrieve(id, opts = {}) ⇒ Permission

Read-only list of all permissions, filterable by model and app

Parameters:

  • id (Integer) —

    A unique integer value identifying this permission.

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

    the optional parameters

Returns:



780
781
782
783
 
# File 'lib/authentik/api/api/rbac_api.rb', line 780

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

#rbac_permissions_retrieve_with_http_info(id, opts = {}) ⇒ Array<(Permission, Integer, Hash)>

Read-only list of all permissions, filterable by model and app

Parameters:

  • id (Integer) —

    A unique integer value identifying this permission.

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

    the optional parameters

Returns:

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

    Permission data, response status code and response headers



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

def rbac_permissions_retrieve_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_permissions_retrieve ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RbacApi.rbac_permissions_retrieve"
  end
  # resource path
  local_var_path = '/rbac/permissions/{id}/'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

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

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

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

#rbac_permissions_roles_list(opts = {}) ⇒ PaginatedExtraRoleObjectPermissionList

Get a role’s assigned object permissions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :uuid (String)

Returns:



845
846
847
848
 
# File 'lib/authentik/api/api/rbac_api.rb', line 845

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

#rbac_permissions_roles_list_with_http_info(opts = {}) ⇒ Array<(PaginatedExtraRoleObjectPermissionList, Integer, Hash)>

Get a role&#39;s assigned object permissions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :uuid (String)

Returns:



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/authentik/api/api/rbac_api.rb', line 858

def rbac_permissions_roles_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_permissions_roles_list ...'
  end
  # resource path
  local_var_path = '/rbac/permissions/roles/'

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

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

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

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

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

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

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

#rbac_roles_add_user_create(uuid, user_account_serializer_for_role_request, opts = {}) ⇒ nil

Add user to role

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

  • (nil) 


912
913
914
915
 
# File 'lib/authentik/api/api/rbac_api.rb', line 912

def rbac_roles_add_user_create(uuid, , opts = {})
  rbac_roles_add_user_create_with_http_info(uuid, , opts)
  nil
end

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

Add user to role

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def rbac_roles_add_user_create_with_http_info(uuid, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_add_user_create ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RbacApi.rbac_roles_add_user_create"
  end
  # verify the required parameter 'user_account_serializer_for_role_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'user_account_serializer_for_role_request' when calling RbacApi.rbac_roles_add_user_create"
  end
  # resource path
  local_var_path = '/rbac/roles/{uuid}/add_user/'.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()

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#rbac_roles_create(role_request, opts = {}) ⇒ Role

Role viewset

Parameters:

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

    the optional parameters

Returns:



983
984
985
986
 
# File 'lib/authentik/api/api/rbac_api.rb', line 983

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

#rbac_roles_create_with_http_info(role_request, opts = {}) ⇒ Array<(Role, Integer, Hash)>

Role viewset

Parameters:

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

    the optional parameters

Returns:

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

    Role data, response status code and response headers



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/authentik/api/api/rbac_api.rb', line 992

def rbac_roles_create_with_http_info(role_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_create ...'
  end
  # verify the required parameter 'role_request' is set
  if @api_client.config.client_side_validation && role_request.nil?
    fail ArgumentError, "Missing the required parameter 'role_request' when calling RbacApi.rbac_roles_create"
  end
  # resource path
  local_var_path = '/rbac/roles/'

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

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

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

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

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

Role viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

  • (nil) 


1049
1050
1051
1052
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1049

def rbac_roles_destroy(uuid, opts = {})
  rbac_roles_destroy_with_http_info(uuid, opts)
  nil
end

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

Role viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1058

def rbac_roles_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_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 RbacApi.rbac_roles_destroy"
  end
  # resource path
  local_var_path = '/rbac/roles/{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 => :"RbacApi.rbac_roles_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: RbacApi#rbac_roles_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rbac_roles_list(opts = {}) ⇒ PaginatedRoleList

Role viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :groups (String)
  • :inherited (Boolean) —

    Include inherited roles (requires users or groups filter)

  • :managed (Array<String>)
  • :managed__isnull (Boolean)
  • :name (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :users (Integer)

Returns:



1119
1120
1121
1122
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1119

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

#rbac_roles_list_with_http_info(opts = {}) ⇒ Array<(PaginatedRoleList, Integer, Hash)>

Role viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :groups (String)
  • :inherited (Boolean) —

    Include inherited roles (requires users or groups filter)

  • :managed (Array<String>)
  • :managed__isnull (Boolean)
  • :name (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :search (String) —

    A search term.

  • :users (Integer)

Returns:

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

    PaginatedRoleList data, response status code and response headers



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1137

def rbac_roles_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_list ...'
  end
  # resource path
  local_var_path = '/rbac/roles/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'groups'] = opts[:'groups'] if !opts[:'groups'].nil?
  query_params[:'inherited'] = opts[:'inherited'] if !opts[:'inherited'].nil?
  query_params[:'managed'] = @api_client.build_collection_param(opts[:'managed'], :multi) if !opts[:'managed'].nil?
  query_params[:'managed__isnull'] = opts[:'managed__isnull'] if !opts[:'managed__isnull'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'users'] = opts[:'users'] if !opts[:'users'].nil?

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

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

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

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

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

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

#rbac_roles_partial_update(uuid, opts = {}) ⇒ Role

Role viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Options Hash (opts):

Returns:



1196
1197
1198
1199
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1196

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

#rbac_roles_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(Role, Integer, Hash)>

Role viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Role data, response status code and response headers



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1206

def rbac_roles_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_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 RbacApi.rbac_roles_partial_update"
  end
  # resource path
  local_var_path = '/rbac/roles/{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_role_request'])

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

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

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

#rbac_roles_remove_user_create(uuid, user_account_serializer_for_role_request, opts = {}) ⇒ nil

Remove user from role

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

  • (nil) 


1264
1265
1266
1267
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1264

def rbac_roles_remove_user_create(uuid, , opts = {})
  rbac_roles_remove_user_create_with_http_info(uuid, , opts)
  nil
end

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

Remove user from role

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def rbac_roles_remove_user_create_with_http_info(uuid, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_remove_user_create ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RbacApi.rbac_roles_remove_user_create"
  end
  # verify the required parameter 'user_account_serializer_for_role_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'user_account_serializer_for_role_request' when calling RbacApi.rbac_roles_remove_user_create"
  end
  # resource path
  local_var_path = '/rbac/roles/{uuid}/remove_user/'.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()

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#rbac_roles_retrieve(uuid, opts = {}) ⇒ Role

Role viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:



1335
1336
1337
1338
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1335

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

#rbac_roles_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(Role, Integer, Hash)>

Role viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

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

    Role data, response status code and response headers



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1344

def rbac_roles_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_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 RbacApi.rbac_roles_retrieve"
  end
  # resource path
  local_var_path = '/rbac/roles/{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] || 'Role'

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

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

#rbac_roles_update(uuid, role_request, opts = {}) ⇒ Role

Role viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:



1397
1398
1399
1400
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1397

def rbac_roles_update(uuid, role_request, opts = {})
  data, _status_code, _headers = rbac_roles_update_with_http_info(uuid, role_request, opts)
  data
end

#rbac_roles_update_with_http_info(uuid, role_request, opts = {}) ⇒ Array<(Role, Integer, Hash)>

Role viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this Role.

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

    the optional parameters

Returns:

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

    Role data, response status code and response headers



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

def rbac_roles_update_with_http_info(uuid, role_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_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 RbacApi.rbac_roles_update"
  end
  # verify the required parameter 'role_request' is set
  if @api_client.config.client_side_validation && role_request.nil?
    fail ArgumentError, "Missing the required parameter 'role_request' when calling RbacApi.rbac_roles_update"
  end
  # resource path
  local_var_path = '/rbac/roles/{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(role_request)

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

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

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

#rbac_roles_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 Role.

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

    the optional parameters

Returns:



1468
1469
1470
1471
 
# File 'lib/authentik/api/api/rbac_api.rb', line 1468

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

#rbac_roles_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 Role.

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

    the optional parameters

Returns:

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

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



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

def rbac_roles_used_by_list_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RbacApi.rbac_roles_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 RbacApi.rbac_roles_used_by_list"
  end
  # resource path
  local_var_path = '/rbac/roles/{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 => :"RbacApi.rbac_roles_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: RbacApi#rbac_roles_used_by_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end