Class MFAControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance
object
MFAControllerApi
Implements
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class MFAControllerApi : IMFAControllerApi, IMFAControllerApiSync, IMFAControllerApiAsync, IApiAccessor

Constructors

View Source

MFAControllerApi()

Initializes a new instance of the MFAControllerApi class.

Declaration
public MFAControllerApi()
View Source

MFAControllerApi(string)

Initializes a new instance of the MFAControllerApi class.

Declaration
public MFAControllerApi(string basePath)
Parameters
Type Name Description
string basePath
View Source

MFAControllerApi(Configuration)

Initializes a new instance of the MFAControllerApi class using Configuration object

Declaration
public MFAControllerApi(Configuration configuration)
Parameters
Type Name Description
Configuration configuration

An instance of Configuration
View Source

MFAControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the MFAControllerApi class using a Configuration object and client instance.

Declaration
public MFAControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)
Parameters
Type Name Description
ISynchronousClient client

The client interface for synchronous API access.
IAsynchronousClient asyncClient

The client interface for asynchronous API access.
IReadableConfiguration configuration

The configuration object.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration
public IAsynchronousClient AsynchronousClient { get; set; }
Property Value
Type Description
IAsynchronousClient
View Source

Client

The client for accessing this underlying API synchronously.

Declaration
public ISynchronousClient Client { get; set; }
Property Value
Type Description
ISynchronousClient
View Source

Configuration

Gets or sets the configuration object

Declaration
public IReadableConfiguration Configuration { get; set; }
Property Value
Type Description
IReadableConfiguration

An instance of the Configuration
View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type Description
ExceptionFactory

Methods

View Source

CreateTotpDeviceForCustom(CreateTotpDeviceOtpAuthUrlOptions, int)

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

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateTotpDeviceForCustomAsync(CreateTotpDeviceOtpAuthUrlOptions, int, CancellationToken)

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

Declaration
public Task<TotpDeviceDto> CreateTotpDeviceForCustomAsync(CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<TotpDeviceDto>

Task of TotpDeviceDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateTotpDeviceForCustomWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions, int)

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

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateTotpDeviceForCustomWithHttpInfoAsync(CreateTotpDeviceOtpAuthUrlOptions, int, CancellationToken)

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

Declaration
public Task<ApiResponse<TotpDeviceDto>> CreateTotpDeviceForCustomWithHttpInfoAsync(CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<TotpDeviceDto>>

Task of ApiResponse (TotpDeviceDto)
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 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.

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateTotpDeviceForOtpAuthUrlAsync(CreateTotpDeviceOtpAuthUrlOptions, int, CancellationToken)

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&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.

Declaration
public Task<TotpDeviceDto> CreateTotpDeviceForOtpAuthUrlAsync(CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<TotpDeviceDto>

Task of TotpDeviceDto
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 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.

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateTotpDeviceForOtpAuthUrlWithHttpInfoAsync(CreateTotpDeviceOtpAuthUrlOptions, int, CancellationToken)

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&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.

Declaration
public Task<ApiResponse<TotpDeviceDto>> CreateTotpDeviceForOtpAuthUrlWithHttpInfoAsync(CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateTotpDeviceOtpAuthUrlOptions createTotpDeviceOtpAuthUrlOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<TotpDeviceDto>>

Task of ApiResponse (TotpDeviceDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
string

The base path
View Source

GetTotpDevice(Guid, int)

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

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceAsync(Guid, int, CancellationToken)

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

Declaration
public Task<TotpDeviceDto> GetTotpDeviceAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<TotpDeviceDto>

Task of TotpDeviceDto
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. Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceByAsync(string, string, string, int, CancellationToken)

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.

Declaration
public Task<TotpDeviceOptionalDto> GetTotpDeviceByAsync(string name = null, string issuer = null, string username = null, int operationIndex = 0, CancellationToken cancellationToken = default)
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.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<TotpDeviceOptionalDto>

Task of TotpDeviceOptionalDto
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. Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceByWithHttpInfoAsync(string, string, string, int, CancellationToken)

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.

Declaration
public Task<ApiResponse<TotpDeviceOptionalDto>> GetTotpDeviceByWithHttpInfoAsync(string name = null, string issuer = null, string username = null, int operationIndex = 0, CancellationToken cancellationToken = default)
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.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<TotpDeviceOptionalDto>>

Task of ApiResponse (TotpDeviceOptionalDto)
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 Get Time-Based One-Time Password for a device by its ID.

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceCodeAsync(Guid, DateTime?, int?, int, CancellationToken)

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

Declaration
public Task<TotpDeviceCodeDto> GetTotpDeviceCodeAsync(Guid id, DateTime? at = null, int? minSecondsUntilExpire = null, int operationIndex = 0, CancellationToken cancellationToken = default)
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.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<TotpDeviceCodeDto>

Task of TotpDeviceCodeDto
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 Get Time-Based One-Time Password for a device by its ID.

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceCodeWithHttpInfoAsync(Guid, DateTime?, int?, int, CancellationToken)

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

Declaration
public Task<ApiResponse<TotpDeviceCodeDto>> GetTotpDeviceCodeWithHttpInfoAsync(Guid id, DateTime? at = null, int? minSecondsUntilExpire = null, int operationIndex = 0, CancellationToken cancellationToken = default)
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.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<TotpDeviceCodeDto>>

Task of ApiResponse (TotpDeviceCodeDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceWithHttpInfo(Guid, int)

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

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTotpDeviceWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration
public Task<ApiResponse<TotpDeviceDto>> GetTotpDeviceWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<TotpDeviceDto>>

Task of ApiResponse (TotpDeviceDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call

Implements