Class: CMV4APIClient::GeneralSecurityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cmv4-openapi-client/api/general_security_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GeneralSecurityApi

Returns a new instance of GeneralSecurityApi.



19
20
21
 
# File 'lib/cmv4-openapi-client/api/general_security_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/cmv4-openapi-client/api/general_security_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#security_controller_read_get_security_for_entity(_alias, instance_id, opts = {}) ⇒ DomainObjectPermissions

Get Entity Security Gets the permissions for the logged in user on the requested entities

Parameters:

  • _alias (String)
  • instance_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 28

def security_controller_read_get_security_for_entity(_alias, instance_id, opts = {})
  data, _status_code, _headers = security_controller_read_get_security_for_entity_with_http_info(_alias, instance_id, opts)
  data
end

#security_controller_read_get_security_for_entity_with_http_info(_alias, instance_id, opts = {}) ⇒ Array<(DomainObjectPermissions, Integer, Hash)>

Get Entity Security Gets the permissions for the logged in user on the requested entities

Parameters:

  • _alias (String)
  • instance_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    DomainObjectPermissions data, response status code and response headers



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
83
84
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 39

def security_controller_read_get_security_for_entity_with_http_info(_alias, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralSecurityApi.security_controller_read_get_security_for_entity ...'
  end
  # verify the required parameter 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling GeneralSecurityApi.security_controller_read_get_security_for_entity"
  end
  # resource path
  local_var_path = '/security/entity/{alias}/{instanceId}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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'])

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

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

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

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

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

#security_controller_read_get_security_for_relationship(_alias, instance_id, opts = {}) ⇒ DomainObjectPermissions

Get Relationship Security Gets the permissions for the logged in user on the request relationship

Parameters:

  • _alias (String)
  • instance_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 92

def security_controller_read_get_security_for_relationship(_alias, instance_id, opts = {})
  data, _status_code, _headers = security_controller_read_get_security_for_relationship_with_http_info(_alias, instance_id, opts)
  data
end

#security_controller_read_get_security_for_relationship_with_http_info(_alias, instance_id, opts = {}) ⇒ Array<(DomainObjectPermissions, Integer, Hash)>

Get Relationship Security Gets the permissions for the logged in user on the request relationship

Parameters:

  • _alias (String)
  • instance_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    DomainObjectPermissions data, response status code and response headers



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 103

def security_controller_read_get_security_for_relationship_with_http_info(_alias, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralSecurityApi.security_controller_read_get_security_for_relationship ...'
  end
  # verify the required parameter 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling GeneralSecurityApi.security_controller_read_get_security_for_relationship"
  end
  # resource path
  local_var_path = '/security/relationship/{alias}/{instanceId}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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'])

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

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

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

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

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

#security_controller_read_get_stereotypes_for_user(opts = {}) ⇒ Array<Stereotype>

Get User Stereotypes Gets stereotypes for either the passed or logged in user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_id (Integer)

Returns:



155
156
157
158
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 155

def security_controller_read_get_stereotypes_for_user(opts = {})
  data, _status_code, _headers = security_controller_read_get_stereotypes_for_user_with_http_info(opts)
  data
end

#security_controller_read_get_stereotypes_for_user_with_http_info(opts = {}) ⇒ Array<(Array<Stereotype>, Integer, Hash)>

Get User Stereotypes Gets stereotypes for either the passed or logged in user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_id (Integer)

Returns:

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

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



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
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 165

def security_controller_read_get_stereotypes_for_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralSecurityApi.security_controller_read_get_stereotypes_for_user ...'
  end
  # resource path
  local_var_path = '/security/user/stereotypes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].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] || 'Array<Stereotype>' 

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

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

#security_controller_write_assign_team_to_project(team_id, project_id, opts = {}) ⇒ File

Assign a team to a project Creates an association between the team and project.

Parameters:

  • team_id (Integer)
  • project_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


215
216
217
218
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 215

def security_controller_write_assign_team_to_project(team_id, project_id, opts = {})
  data, _status_code, _headers = security_controller_write_assign_team_to_project_with_http_info(team_id, project_id, opts)
  data
end

#security_controller_write_assign_team_to_project_with_http_info(team_id, project_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Assign a team to a project Creates an association between the team and project.

Parameters:

  • team_id (Integer)
  • project_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 226

def security_controller_write_assign_team_to_project_with_http_info(team_id, project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralSecurityApi.security_controller_write_assign_team_to_project ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling GeneralSecurityApi.security_controller_write_assign_team_to_project"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling GeneralSecurityApi.security_controller_write_assign_team_to_project"
  end
  # resource path
  local_var_path = '/security/{teamId}/{projectId}/assignteamtoproject'.sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_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/octet-stream'])

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

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

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

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

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

#security_controller_write_assign_user_to_team(team_id, grant_team_membership_command_data, opts = {}) ⇒ File

Assign a user to a team Creates an association between the user and team.

Parameters:

Returns:

  • (File) 


283
284
285
286
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 283

def security_controller_write_assign_user_to_team(team_id, grant_team_membership_command_data, opts = {})
  data, _status_code, _headers = security_controller_write_assign_user_to_team_with_http_info(team_id, grant_team_membership_command_data, opts)
  data
end

#security_controller_write_assign_user_to_team_with_http_info(team_id, grant_team_membership_command_data, opts = {}) ⇒ Array<(File, Integer, Hash)>

Assign a user to a team Creates an association between the user and team.

Parameters:

Returns:

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

    File data, response status code and response headers



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

def security_controller_write_assign_user_to_team_with_http_info(team_id, grant_team_membership_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralSecurityApi.security_controller_write_assign_user_to_team ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling GeneralSecurityApi.security_controller_write_assign_user_to_team"
  end
  # verify the required parameter 'grant_team_membership_command_data' is set
  if @api_client.config.client_side_validation && grant_team_membership_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'grant_team_membership_command_data' when calling GeneralSecurityApi.security_controller_write_assign_user_to_team"
  end
  # resource path
  local_var_path = '/security/{teamId}/assignusertoteam'.sub('{' + 'teamId' + '}', CGI.escape(team_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/octet-stream'])
  # 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(grant_team_membership_command_data) 

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

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

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

#security_controller_write_remove_team_from_project(team_id, project_id, opts = {}) ⇒ File

Remove Team to Project association Removes the association between a Team and a Project.

Parameters:

  • team_id (Integer)
  • project_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


353
354
355
356
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 353

def security_controller_write_remove_team_from_project(team_id, project_id, opts = {})
  data, _status_code, _headers = security_controller_write_remove_team_from_project_with_http_info(team_id, project_id, opts)
  data
end

#security_controller_write_remove_team_from_project_with_http_info(team_id, project_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Remove Team to Project association Removes the association between a Team and a Project.

Parameters:

  • team_id (Integer)
  • project_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
413
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 364

def security_controller_write_remove_team_from_project_with_http_info(team_id, project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralSecurityApi.security_controller_write_remove_team_from_project ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling GeneralSecurityApi.security_controller_write_remove_team_from_project"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling GeneralSecurityApi.security_controller_write_remove_team_from_project"
  end
  # resource path
  local_var_path = '/security/{teamId}/{projectId}/removeteamfromproject'.sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s)).sub('{' + 'projectId' + '}', CGI.escape(project_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/octet-stream'])

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

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

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

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

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

#security_controller_write_remove_user_from_team(team_id, user_id, opts = {}) ⇒ File

Remove a user from a team Removes the specified user from the team.

Parameters:

  • team_id (Integer)
  • user_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


421
422
423
424
 
# File 'lib/cmv4-openapi-client/api/general_security_api.rb', line 421

def security_controller_write_remove_user_from_team(team_id, user_id, opts = {})
  data, _status_code, _headers = security_controller_write_remove_user_from_team_with_http_info(team_id, user_id, opts)
  data
end

#security_controller_write_remove_user_from_team_with_http_info(team_id, user_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Remove a user from a team Removes the specified user from the team.

Parameters:

  • team_id (Integer)
  • user_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    File data, response status code and response headers



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

def security_controller_write_remove_user_from_team_with_http_info(team_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralSecurityApi.security_controller_write_remove_user_from_team ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling GeneralSecurityApi.security_controller_write_remove_user_from_team"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling GeneralSecurityApi.security_controller_write_remove_user_from_team"
  end
  # resource path
  local_var_path = '/security/{teamId}/{userId}/removeuserfromteam'.sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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/octet-stream'])

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

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

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

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

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