Class: RBACApiClient::RoleApi

Inherits:
Object
  • Object
show all
Defined in:
lib/rbac-api-client/api/role_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoleApi

Returns a new instance of RoleApi.



19
20
21
 
# File 'lib/rbac-api-client/api/role_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/rbac-api-client/api/role_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_roles(role_in, opts = {}) ⇒ RoleWithAccess

Create a roles for a tenant

Parameters:

  • role_in (RoleIn) —

    Role to create

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/rbac-api-client/api/role_api.rb', line 26

def create_roles(role_in, opts = {})
  data, _status_code, _headers = create_roles_with_http_info(role_in, opts)
  data
end

#create_roles_with_http_info(role_in, opts = {}) ⇒ Array<(RoleWithAccess, Integer, Hash)>

Create a roles for a tenant

Parameters:

  • role_in (RoleIn) —

    Role to create

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

    the optional parameters

Returns:

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

    RoleWithAccess data, response status code and response headers



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
81
82
 
# File 'lib/rbac-api-client/api/role_api.rb', line 35

def create_roles_with_http_info(role_in, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleApi.create_roles ...'
  end
  # verify the required parameter 'role_in' is set
  if @api_client.config.client_side_validation && role_in.nil?
    fail ArgumentError, "Missing the required parameter 'role_in' when calling RoleApi.create_roles"
  end
  # resource path
  local_var_path = '/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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'RoleWithAccess' 

  # auth_names
  auth_names = opts[:auth_names] || ['basic_auth']

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

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

Delete a role in the tenant

Parameters:

  • uuid (String) —

    ID of role to delete

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/rbac-api-client/api/role_api.rb', line 88

def delete_role(uuid, opts = {})
  delete_role_with_http_info(uuid, opts)
  nil
end

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

Delete a role in the tenant

Parameters:

  • uuid (String) —

    ID of role to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/rbac-api-client/api/role_api.rb', line 97

def delete_role_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleApi.delete_role ...'
  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 RoleApi.delete_role"
  end
  # resource path
  local_var_path = '/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'])

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['basic_auth']

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

#get_role(uuid, opts = {}) ⇒ RoleWithAccess

Get a role in the tenant

Parameters:

  • uuid (String) —

    ID of role to get

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

    the optional parameters

Returns:



148
149
150
151
 
# File 'lib/rbac-api-client/api/role_api.rb', line 148

def get_role(uuid, opts = {})
  data, _status_code, _headers = get_role_with_http_info(uuid, opts)
  data
end

#get_role_access(uuid, opts = {}) ⇒ AccessPagination

Get access for a role in the tenant

Parameters:

  • uuid (String) —

    ID of the role

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Parameter for selecting the amount of data returned. (default to 10)

  • :offset (Integer) —

    Parameter for selecting the offset of data. (default to 0)

Returns:



210
211
212
213
 
# File 'lib/rbac-api-client/api/role_api.rb', line 210

def get_role_access(uuid, opts = {})
  data, _status_code, _headers = get_role_access_with_http_info(uuid, opts)
  data
end

#get_role_access_with_http_info(uuid, opts = {}) ⇒ Array<(AccessPagination, Integer, Hash)>

Get access for a role in the tenant

Parameters:

  • uuid (String) —

    ID of the role

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Parameter for selecting the amount of data returned.

  • :offset (Integer) —

    Parameter for selecting the offset of data.

Returns:

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

    AccessPagination data, response status code and response headers



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
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/rbac-api-client/api/role_api.rb', line 221

def get_role_access_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleApi.get_role_access ...'
  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 RoleApi.get_role_access"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RoleApi.get_role_access, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RoleApi.get_role_access, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling RoleApi.get_role_access, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/roles/{uuid}/access/'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'AccessPagination' 

  # auth_names
  auth_names = opts[:auth_names] || ['basic_auth']

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

#get_role_with_http_info(uuid, opts = {}) ⇒ Array<(RoleWithAccess, Integer, Hash)>

Get a role in the tenant

Parameters:

  • uuid (String) —

    ID of role to get

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

    the optional parameters

Returns:

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

    RoleWithAccess data, 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
 
# File 'lib/rbac-api-client/api/role_api.rb', line 157

def get_role_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleApi.get_role ...'
  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 RoleApi.get_role"
  end
  # resource path
  local_var_path = '/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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'RoleWithAccess' 

  # auth_names
  auth_names = opts[:auth_names] || ['basic_auth']

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

#list_roles(opts = {}) ⇒ RolePaginationDynamic

List the roles for a tenant

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Parameter for selecting the amount of data returned. (default to 10)

  • :offset (Integer) —

    Parameter for selecting the offset of data. (default to 0)

  • :name (String) —

    Parameter for filtering resource by name using string contains search.

  • :scope (String) —

    Parameter for filtering resource by scope. (default to ‘account’)

  • :order_by (String) —

    Parameter for ordering resource by value. For inverse ordering, supply &#39;-&#39; before the param value, such as: ?order_by&#x3D;-name

  • :add_fields (Array<String>) —

    Parameter for add list of fields to display for roles.

  • :username (String) —

    Unique username of the principal to obtain roles for (only available for admins, and if supplied, takes precedence over the identity header).

Returns:



292
293
294
295
 
# File 'lib/rbac-api-client/api/role_api.rb', line 292

def list_roles(opts = {})
  data, _status_code, _headers = list_roles_with_http_info(opts)
  data
end

#list_roles_with_http_info(opts = {}) ⇒ Array<(RolePaginationDynamic, Integer, Hash)>

List the roles for a tenant

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Parameter for selecting the amount of data returned.

  • :offset (Integer) —

    Parameter for selecting the offset of data.

  • :name (String) —

    Parameter for filtering resource by name using string contains search.

  • :scope (String) —

    Parameter for filtering resource by scope.

  • :order_by (String) —

    Parameter for ordering resource by value. For inverse ordering, supply &#39;-&#39; before the param value, such as: ?order_by&#x3D;-name

  • :add_fields (Array<String>) —

    Parameter for add list of fields to display for roles.

  • :username (String) —

    Unique username of the principal to obtain roles for (only available for admins, and if supplied, takes precedence over the identity header).

Returns:

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

    RolePaginationDynamic data, response status code and response headers



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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/rbac-api-client/api/role_api.rb', line 307

def list_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleApi.list_roles ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RoleApi.list_roles, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RoleApi.list_roles, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling RoleApi.list_roles, must be greater than or equal to 0.'
  end

  allowable_values = ["account", "principal"]
  if @api_client.config.client_side_validation && opts[:'scope'] && !allowable_values.include?(opts[:'scope'])
    fail ArgumentError, "invalid value for \"scope\", must be one of #{allowable_values}"
  end
  allowable_values = ["groups_in", "groups_in_count"]
  if @api_client.config.client_side_validation && opts[:'add_fields'] && !opts[:'add_fields'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"add_fields\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/roles/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'add_fields'] = @api_client.build_collection_param(opts[:'add_fields'], :csv) if !opts[:'add_fields'].nil?
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'RolePaginationDynamic' 

  # auth_names
  auth_names = opts[:auth_names] || ['basic_auth']

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

#update_role(uuid, role_with_access, opts = {}) ⇒ nil

Update a Role in the tenant

Parameters:

  • uuid (String) —

    ID of role to update

  • role_with_access (RoleWithAccess) —

    Update to a Role

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

    the optional parameters

Returns:

  • (nil) 


382
383
384
385
 
# File 'lib/rbac-api-client/api/role_api.rb', line 382

def update_role(uuid, role_with_access, opts = {})
  update_role_with_http_info(uuid, role_with_access, opts)
  nil
end

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

Update a Role in the tenant

Parameters:

  • uuid (String) —

    ID of role to update

  • role_with_access (RoleWithAccess) —

    Update to a Role

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def update_role_with_http_info(uuid, role_with_access, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleApi.update_role ...'
  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 RoleApi.update_role"
  end
  # verify the required parameter 'role_with_access' is set
  if @api_client.config.client_side_validation && role_with_access.nil?
    fail ArgumentError, "Missing the required parameter 'role_with_access' when calling RoleApi.update_role"
  end
  # resource path
  local_var_path = '/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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['basic_auth']

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