Class: MailSlurpClient::MFAControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/api/mfa_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MFAControllerApi

Returns a new instance of MFAControllerApi.



19
20
21
 
# File 'lib/mailslurp_client/api/mfa_controller_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/mailslurp_client/api/mfa_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_totp_device_for_base32_secret_key(create_totp_device_base32_secret_key_options, opts = {}) ⇒ TotpDeviceDto

Create a TOTP device from an base32 secret key Create a virtual TOTP device for a given secret key. This is usually present as an alternative login option when pairing OTP devices.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 27

def create_totp_device_for_base32_secret_key(create_totp_device_base32_secret_key_options, opts = {})
  data, _status_code, _headers = create_totp_device_for_base32_secret_key_with_http_info(create_totp_device_base32_secret_key_options, opts)
  data
end

#create_totp_device_for_base32_secret_key_with_http_info(create_totp_device_base32_secret_key_options, opts = {}) ⇒ Array<(TotpDeviceDto, Integer, Hash)>

Create a TOTP device from an base32 secret key Create a virtual TOTP device for a given secret key. This is usually present as an alternative login option when pairing OTP devices.

Parameters:

Returns:

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

    TotpDeviceDto data, response status code and response headers



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
83
84
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 37

def create_totp_device_for_base32_secret_key_with_http_info(create_totp_device_base32_secret_key_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MFAControllerApi.create_totp_device_for_base32_secret_key ...'
  end
  # verify the required parameter 'create_totp_device_base32_secret_key_options' is set
  if @api_client.config.client_side_validation && create_totp_device_base32_secret_key_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_totp_device_base32_secret_key_options' when calling MFAControllerApi.create_totp_device_for_base32_secret_key"
  end
  # resource path
  local_var_path = '/mfa/totp/device/base32SecretKey'

  # 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(['*/*'])
  # 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(create_totp_device_base32_secret_key_options) 

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

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

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

#create_totp_device_for_custom(create_totp_device_custom_options, opts = {}) ⇒ TotpDeviceDto

Create a TOTP device from custom options Create a virtual TOTP device for custom options specifying all parameters of the TOTP device.

Parameters:

Returns:



91
92
93
94
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 91

def create_totp_device_for_custom(create_totp_device_custom_options, opts = {})
  data, _status_code, _headers = create_totp_device_for_custom_with_http_info(create_totp_device_custom_options, opts)
  data
end

#create_totp_device_for_custom_with_http_info(create_totp_device_custom_options, opts = {}) ⇒ Array<(TotpDeviceDto, Integer, Hash)>

Create a TOTP device from custom options Create a virtual TOTP device for custom options specifying all parameters of the TOTP device.

Parameters:

Returns:

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

    TotpDeviceDto data, response status code and response headers



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
143
144
145
146
147
148
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 101

def create_totp_device_for_custom_with_http_info(create_totp_device_custom_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MFAControllerApi.create_totp_device_for_custom ...'
  end
  # verify the required parameter 'create_totp_device_custom_options' is set
  if @api_client.config.client_side_validation && create_totp_device_custom_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_totp_device_custom_options' when calling MFAControllerApi.create_totp_device_for_custom"
  end
  # resource path
  local_var_path = '/mfa/totp/device/custom'

  # 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(['*/*'])
  # 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(create_totp_device_custom_options) 

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

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

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

#create_totp_device_for_otp_auth_url(create_totp_device_otp_auth_url_options, opts = {}) ⇒ TotpDeviceDto

Create a TOTP device from an OTP Auth URL Create a virtual TOTP device for a given OTP Auth URL such as otpauth://totp/MyApp:alice@example.com?secret=ABC123&issuer=MyApp&period=30&digits=6&algorithm=SHA1. You can provider overrides in the options for each component of the URL.

Parameters:

Returns:



155
156
157
158
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 155

def create_totp_device_for_otp_auth_url(create_totp_device_otp_auth_url_options, opts = {})
  data, _status_code, _headers = create_totp_device_for_otp_auth_url_with_http_info(create_totp_device_otp_auth_url_options, opts)
  data
end

#create_totp_device_for_otp_auth_url_with_http_info(create_totp_device_otp_auth_url_options, opts = {}) ⇒ Array<(TotpDeviceDto, Integer, Hash)>

Create a TOTP device from an OTP Auth URL Create a virtual TOTP device for a given OTP Auth URL such as otpauth://totp/MyApp:alice@example.com?secret&#x3D;ABC123&amp;issuer&#x3D;MyApp&amp;period&#x3D;30&amp;digits&#x3D;6&amp;algorithm&#x3D;SHA1. You can provider overrides in the options for each component of the URL.

Parameters:

Returns:

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

    TotpDeviceDto 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
208
209
210
211
212
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 165

def create_totp_device_for_otp_auth_url_with_http_info(create_totp_device_otp_auth_url_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MFAControllerApi.create_totp_device_for_otp_auth_url ...'
  end
  # verify the required parameter 'create_totp_device_otp_auth_url_options' is set
  if @api_client.config.client_side_validation && create_totp_device_otp_auth_url_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_totp_device_otp_auth_url_options' when calling MFAControllerApi.create_totp_device_for_otp_auth_url"
  end
  # resource path
  local_var_path = '/mfa/totp/device/otpAuthUrl'

  # 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(['*/*'])
  # 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(create_totp_device_otp_auth_url_options) 

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

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

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

#get_totp_device(id, opts = {}) ⇒ TotpDeviceDto

Get a TOTP device by ID Get Time-Based One-Time Password (TOTP) device by its ID.

Parameters:

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

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 219

def get_totp_device(id, opts = {})
  data, _status_code, _headers = get_totp_device_with_http_info(id, opts)
  data
end

#get_totp_device_by(opts = {}) ⇒ TotpDeviceOptionalDto

Get a TOTP device by username, issuer, or name. Returns empty if not found. Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Optional name filter

  • :issuer (String) —

    Optional issuer filter

  • :username (String) —

    Optional username filter

Returns:



283
284
285
286
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 283

def get_totp_device_by(opts = {})
  data, _status_code, _headers = get_totp_device_by_with_http_info(opts)
  data
end

#get_totp_device_by_with_http_info(opts = {}) ⇒ Array<(TotpDeviceOptionalDto, Integer, Hash)>

Get a TOTP device by username, issuer, or name. Returns empty if not found. Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Optional name filter

  • :issuer (String) —

    Optional issuer filter

  • :username (String) —

    Optional username filter

Returns:

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

    TotpDeviceOptionalDto data, response status code and response headers



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
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 295

def get_totp_device_by_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MFAControllerApi.get_totp_device_by ...'
  end
  # resource path
  local_var_path = '/mfa/totp/device/by'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'issuer'] = opts[:'issuer'] if !opts[:'issuer'].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(['*/*'])

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

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

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

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

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

#get_totp_device_code(id, opts = {}) ⇒ TotpDeviceCodeDto

Get a TOTP device code by device ID Get Time-Based One-Time Password for a device by its ID.

Parameters:

  • id (String) —

    ID of the TOTP device to get the code for

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

    the optional parameters

Options Hash (opts):

  • :at (DateTime) —

    Optional time to get code for. If not provided, current time is used.

  • :min_seconds_until_expire (Integer) —

    Optional minimum time until code expires. Will hold thread open until period reached. (default to 5)

Returns:



348
349
350
351
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 348

def get_totp_device_code(id, opts = {})
  data, _status_code, _headers = get_totp_device_code_with_http_info(id, opts)
  data
end

#get_totp_device_code_with_http_info(id, opts = {}) ⇒ Array<(TotpDeviceCodeDto, Integer, Hash)>

Get a TOTP device code by device ID Get Time-Based One-Time Password for a device by its ID.

Parameters:

  • id (String) —

    ID of the TOTP device to get the code for

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

    the optional parameters

Options Hash (opts):

  • :at (DateTime) —

    Optional time to get code for. If not provided, current time is used.

  • :min_seconds_until_expire (Integer) —

    Optional minimum time until code expires. Will hold thread open until period reached.

Returns:

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

    TotpDeviceCodeDto data, response status code and response headers



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
413
414
415
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 360

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

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

  # resource path
  local_var_path = '/mfa/totp/device/{id}/code'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'minSecondsUntilExpire'] = opts[:'min_seconds_until_expire'] if !opts[:'min_seconds_until_expire'].nil?

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

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

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

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

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

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

#get_totp_device_with_http_info(id, opts = {}) ⇒ Array<(TotpDeviceDto, Integer, Hash)>

Get a TOTP device by ID Get Time-Based One-Time Password (TOTP) device by its ID.

Parameters:

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

    the optional parameters

Returns:

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

    TotpDeviceDto 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
 
# File 'lib/mailslurp_client/api/mfa_controller_api.rb', line 229

def get_totp_device_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MFAControllerApi.get_totp_device ...'
  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 MFAControllerApi.get_totp_device"
  end
  # resource path
  local_var_path = '/mfa/totp/device/{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(['*/*'])

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

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

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

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

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