Class: RBACApiClient::PolicyApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PolicyApi

Returns a new instance of PolicyApi.



19
20
21
 
# File 'lib/rbac-api-client/api/policy_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/policy_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_policies(policy_in, opts = {}) ⇒ PolicyExtended

Create a policy in a tenant

Parameters:

  • policy_in (PolicyIn) —

    Policy to create

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

    the optional parameters

Returns:



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

def create_policies(policy_in, opts = {})
  data, _status_code, _headers = create_policies_with_http_info(policy_in, opts)
  data
end

#create_policies_with_http_info(policy_in, opts = {}) ⇒ Array<(PolicyExtended, Integer, Hash)>

Create a policy in a tenant

Parameters:

  • policy_in (PolicyIn) —

    Policy to create

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

    the optional parameters

Returns:

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

    PolicyExtended 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/policy_api.rb', line 35

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

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

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

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

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

Delete a policy in the tenant

Parameters:

  • uuid (String) —

    ID of policy to delete

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_policy(uuid, opts = {})
  delete_policy_with_http_info(uuid, opts)
  nil
end

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

Delete a policy in the tenant

Parameters:

  • uuid (String) —

    ID of policy 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/policy_api.rb', line 97

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

#get_policy(uuid, opts = {}) ⇒ PolicyExtended

Get a policy in the tenant

Parameters:

  • uuid (String) —

    ID of policy to get

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

    the optional parameters

Returns:



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

def get_policy(uuid, opts = {})
  data, _status_code, _headers = get_policy_with_http_info(uuid, opts)
  data
end

#get_policy_with_http_info(uuid, opts = {}) ⇒ Array<(PolicyExtended, Integer, Hash)>

Get a policy in the tenant

Parameters:

  • uuid (String) —

    ID of policy to get

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

    the optional parameters

Returns:

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

    PolicyExtended 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/policy_api.rb', line 157

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

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

#list_policies(opts = {}) ⇒ PolicyPagination

List the policies in the 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’)

  • :group_name (String) —

    Parameter for filtering resource by group name using string contains search.

  • :group_uuid (String) —

    Parameter for filtering resource by group uuid using UUID exact match.

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

Returns:



214
215
216
217
 
# File 'lib/rbac-api-client/api/policy_api.rb', line 214

def list_policies(opts = {})
  data, _status_code, _headers = list_policies_with_http_info(opts)
  data
end

#list_policies_with_http_info(opts = {}) ⇒ Array<(PolicyPagination, Integer, Hash)>

List the policies in the 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.

  • :group_name (String) —

    Parameter for filtering resource by group name using string contains search.

  • :group_uuid (String) —

    Parameter for filtering resource by group uuid using UUID exact match.

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

Returns:

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

    PolicyPagination data, response status code and response headers



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
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/rbac-api-client/api/policy_api.rb', line 229

def list_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyApi.list_policies ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PolicyApi.list_policies, 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 PolicyApi.list_policies, 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 PolicyApi.list_policies, 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
  # resource path
  local_var_path = '/policies/'

  # 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[:'group_name'] = opts[:'group_name'] if !opts[:'group_name'].nil?
  query_params[:'group_uuid'] = opts[:'group_uuid'] if !opts[:'group_uuid'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].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] || 'PolicyPagination' 

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

#update_policy(uuid, policy_in, opts = {}) ⇒ PolicyExtended

Update a policy in the tenant

Parameters:

  • uuid (String) —

    ID of policy to update

  • policy_in (PolicyIn) —

    Policy to update

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

    the optional parameters

Returns:



300
301
302
303
 
# File 'lib/rbac-api-client/api/policy_api.rb', line 300

def update_policy(uuid, policy_in, opts = {})
  data, _status_code, _headers = update_policy_with_http_info(uuid, policy_in, opts)
  data
end

#update_policy_with_http_info(uuid, policy_in, opts = {}) ⇒ Array<(PolicyExtended, Integer, Hash)>

Update a policy in the tenant

Parameters:

  • uuid (String) —

    ID of policy to update

  • policy_in (PolicyIn) —

    Policy to update

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

    the optional parameters

Returns:

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

    PolicyExtended data, response status code and response headers



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

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

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

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