Class: SwaggerClient::CredentialApi

Inherits:
Object
  • Object
show all
Defined in:
lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CredentialApi

Returns a new instance of CredentialApi.



16
17
18
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_shared_credential(opts = {}) ⇒ CreatedReferenceCredentialIDLink

Shared Credentials Creates a new shared credential.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



24
25
26
27
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 24

def create_shared_credential(opts = {})
  data, _status_code, _headers = create_shared_credential_with_http_info(opts)
  data
end

#create_shared_credential_with_http_info(opts = {}) ⇒ Array<(CreatedReferenceCredentialIDLink, Integer, Hash)>

Shared Credentials Creates a new shared credential.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 34

def create_shared_credential_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialApi.create_shared_credential ...'
  end
  # resource path
  local_var_path = '/api/3/shared_credentials'

  # 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;charset=UTF-8'])
  # 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(opts[:'body']) 

  return_type = opts[:return_type] || 'CreatedReferenceCredentialIDLink' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialApi#create_shared_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_all_shared_credentials(opts = {}) ⇒ Links

Shared Credentials Deletes all shared credentials.

Parameters:

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 77

def delete_all_shared_credentials(opts = {})
  data, _status_code, _headers = delete_all_shared_credentials_with_http_info(opts)
  data
end

#delete_all_shared_credentials_with_http_info(opts = {}) ⇒ Array<(Links, Integer, Hash)>

Shared Credentials Deletes all shared credentials.

Parameters:

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 86

def delete_all_shared_credentials_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialApi.delete_all_shared_credentials ...'
  end
  # resource path
  local_var_path = '/api/3/shared_credentials'

  # 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;charset=UTF-8'])

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

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

  return_type = opts[:return_type] || 'Links' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialApi#delete_all_shared_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_shared_credential(site_idte_id, opts = {}) ⇒ Links

Shared Credential Deletes the specified shared scan credential.

Parameters:

  • id —

    The identifier of the credential.

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

    the optional parameters

Returns:



128
129
130
131
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 128

def delete_shared_credential(site_idte_id, opts = {})
  data, _status_code, _headers = delete_shared_credential_with_http_info(site_idte_id, opts)
  data
end

#delete_shared_credential_with_http_info(site_idte_id, opts = {}) ⇒ Array<(Links, Integer, Hash)>

Shared Credential Deletes the specified shared scan credential.

Parameters:

  • id —

    The identifier of the credential.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 138

def delete_shared_credential_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialApi.delete_shared_credential ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CredentialApi.delete_shared_credential"
  end
  # resource path
  local_var_path = '/api/3/shared_credentials/{id}'.sub('{' + 'id' + '}', site_idte_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;charset=UTF-8'])

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

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

  return_type = opts[:return_type] || 'Links' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialApi#delete_shared_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_shared_credential(site_idte_id, opts = {}) ⇒ SharedCredential

Shared Credential Retrieves the specified shared credential.

Parameters:

  • id —

    The identifier of the credential.

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

    the optional parameters

Returns:



184
185
186
187
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 184

def get_shared_credential(site_idte_id, opts = {})
  data, _status_code, _headers = get_shared_credential_with_http_info(site_idte_id, opts)
  data
end

#get_shared_credential_with_http_info(site_idte_id, opts = {}) ⇒ Array<(SharedCredential, Integer, Hash)>

Shared Credential Retrieves the specified shared credential.

Parameters:

  • id —

    The identifier of the credential.

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

    the optional parameters

Returns:

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

    SharedCredential data, response status code and response headers



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 194

def get_shared_credential_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialApi.get_shared_credential ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CredentialApi.get_shared_credential"
  end
  # resource path
  local_var_path = '/api/3/shared_credentials/{id}'.sub('{' + 'id' + '}', site_idte_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;charset=UTF-8'])

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

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

  return_type = opts[:return_type] || 'SharedCredential' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialApi#get_shared_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_shared_credentials(opts = {}) ⇒ ResourcesSharedCredential

Shared Credentials Retrieves all defined shared credential resources.

Parameters:

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

    the optional parameters

Returns:



239
240
241
242
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 239

def get_shared_credentials(opts = {})
  data, _status_code, _headers = get_shared_credentials_with_http_info(opts)
  data
end

#get_shared_credentials_with_http_info(opts = {}) ⇒ Array<(ResourcesSharedCredential, Integer, Hash)>

Shared Credentials Retrieves all defined shared credential resources.

Parameters:

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

    the optional parameters

Returns:

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

    ResourcesSharedCredential data, response status code and response headers



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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 248

def get_shared_credentials_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialApi.get_shared_credentials ...'
  end
  # resource path
  local_var_path = '/api/3/shared_credentials'

  # 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;charset=UTF-8'])

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

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

  return_type = opts[:return_type] || 'ResourcesSharedCredential' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialApi#get_shared_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_shared_credential(site_idte_id, opts = {}) ⇒ Links

Shared Credential Updates the specified shared credential.

Parameters:

  • id —

    The identifier of the credential.

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

    the optional parameters

Options Hash (opts):

  • :body (SharedCredential) —

    The specification of the shared credential to update.

Returns:



291
292
293
294
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 291

def update_shared_credential(site_idte_id, opts = {})
  data, _status_code, _headers = update_shared_credential_with_http_info(site_idte_id, opts)
  data
end

#update_shared_credential_with_http_info(site_idte_id, opts = {}) ⇒ Array<(Links, Integer, Hash)>

Shared Credential Updates the specified shared credential.

Parameters:

  • id —

    The identifier of the credential.

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

    the optional parameters

Options Hash (opts):

  • :body (SharedCredential) —

    The specification of the shared credential to update.

Returns:

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

    Links data, response status code and response headers



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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/credential_api.rb', line 302

def update_shared_credential_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialApi.update_shared_credential ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CredentialApi.update_shared_credential"
  end
  # resource path
  local_var_path = '/api/3/shared_credentials/{id}'.sub('{' + 'id' + '}', site_idte_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;charset=UTF-8'])
  # 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(opts[:'body']) 

  return_type = opts[:return_type] || 'Links' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialApi#update_shared_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end