Interface IMFAControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IMFAControllerApiSync : IApiAccessor

Methods

View Source

CreateTotpDeviceForCustom(CreateTotpDeviceOtpAuthUrlOptions, int)

Create a TOTP device from custom options

Declaration
TotpDeviceDto CreateTotpDeviceForCustom(CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
TotpDeviceDto

TotpDeviceDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateTotpDeviceForCustomWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions, int)

Create a TOTP device from custom options

Declaration
ApiResponse<TotpDeviceDto> CreateTotpDeviceForCustomWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<TotpDeviceDto>

ApiResponse of TotpDeviceDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateTotpDeviceForOtpAuthUrl(CreateTotpDeviceOtpAuthUrlOptions, int)

Create a TOTP device from an OTP Auth URL

Declaration
TotpDeviceDto CreateTotpDeviceForOtpAuthUrl(CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
TotpDeviceDto

TotpDeviceDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateTotpDeviceForOtpAuthUrlWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions, int)

Create a TOTP device from an OTP Auth URL

Declaration
ApiResponse<TotpDeviceDto> CreateTotpDeviceForOtpAuthUrlWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<TotpDeviceDto>

ApiResponse of TotpDeviceDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDevice(Guid, int)

Get a TOTP device by ID

Declaration
TotpDeviceDto GetTotpDevice(Guid id, int operationIndex = 0)
Parameters
Type Name Description
Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
TotpDeviceDto

TotpDeviceDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceBy(string, string, string, int)

Get a TOTP device by username, issuer, or name. Returns empty if not found.

Declaration
TotpDeviceOptionalDto GetTotpDeviceBy(string name = null, string issuer = null, string username = null, int operationIndex = 0)
Parameters
Type Name Description
string name

Optional name filter (optional)
string issuer

Optional issuer filter (optional)
string username

Optional username filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
TotpDeviceOptionalDto

TotpDeviceOptionalDto
Remarks

Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceByWithHttpInfo(string, string, string, int)

Get a TOTP device by username, issuer, or name. Returns empty if not found.

Declaration
ApiResponse<TotpDeviceOptionalDto> GetTotpDeviceByWithHttpInfo(string name = null, string issuer = null, string username = null, int operationIndex = 0)
Parameters
Type Name Description
string name

Optional name filter (optional)
string issuer

Optional issuer filter (optional)
string username

Optional username filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<TotpDeviceOptionalDto>

ApiResponse of TotpDeviceOptionalDto
Remarks

Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceCode(Guid, DateTime?, int?, int)

Get a TOTP device code by device ID

Declaration
TotpDeviceCodeDto GetTotpDeviceCode(Guid id, DateTime? at = null, int? minSecondsUntilExpire = null, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of the TOTP device to get the code for
DateTime? at

Optional time to get code for. If not provided, current time is used. (optional)
int? minSecondsUntilExpire

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

Index associated with the operation.
Returns
Type Description
TotpDeviceCodeDto

TotpDeviceCodeDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceCodeWithHttpInfo(Guid, DateTime?, int?, int)

Get a TOTP device code by device ID

Declaration
ApiResponse<TotpDeviceCodeDto> GetTotpDeviceCodeWithHttpInfo(Guid id, DateTime? at = null, int? minSecondsUntilExpire = null, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of the TOTP device to get the code for
DateTime? at

Optional time to get code for. If not provided, current time is used. (optional)
int? minSecondsUntilExpire

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

Index associated with the operation.
Returns
Type Description
ApiResponse<TotpDeviceCodeDto>

ApiResponse of TotpDeviceCodeDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceWithHttpInfo(Guid, int)

Get a TOTP device by ID

Declaration
ApiResponse<TotpDeviceDto> GetTotpDeviceWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<TotpDeviceDto>

ApiResponse of TotpDeviceDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call