MFAControllerApi
in package
MFAControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createTotpDeviceForCustom' => ['application/json'], 'createTotpDeviceForOtpAuthUrl' => ['application/json'], 'getTotpDevice' => ['application/json'], 'getTotpDeviceBy' => ['application/json'], 'getTotpDeviceCode' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createTotpDeviceForCustom() : TotpDeviceDto
- Operation createTotpDeviceForCustom
- createTotpDeviceForCustomAsync() : PromiseInterface
- Operation createTotpDeviceForCustomAsync
- createTotpDeviceForCustomAsyncWithHttpInfo() : PromiseInterface
- Operation createTotpDeviceForCustomAsyncWithHttpInfo
- createTotpDeviceForCustomRequest() : Request
- Create request for operation 'createTotpDeviceForCustom'
- createTotpDeviceForCustomWithHttpInfo() : array<string|int, mixed>
- Operation createTotpDeviceForCustomWithHttpInfo
- createTotpDeviceForOtpAuthUrl() : TotpDeviceDto
- Operation createTotpDeviceForOtpAuthUrl
- createTotpDeviceForOtpAuthUrlAsync() : PromiseInterface
- Operation createTotpDeviceForOtpAuthUrlAsync
- createTotpDeviceForOtpAuthUrlAsyncWithHttpInfo() : PromiseInterface
- Operation createTotpDeviceForOtpAuthUrlAsyncWithHttpInfo
- createTotpDeviceForOtpAuthUrlRequest() : Request
- Create request for operation 'createTotpDeviceForOtpAuthUrl'
- createTotpDeviceForOtpAuthUrlWithHttpInfo() : array<string|int, mixed>
- Operation createTotpDeviceForOtpAuthUrlWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getTotpDevice() : TotpDeviceDto
- Operation getTotpDevice
- getTotpDeviceAsync() : PromiseInterface
- Operation getTotpDeviceAsync
- getTotpDeviceAsyncWithHttpInfo() : PromiseInterface
- Operation getTotpDeviceAsyncWithHttpInfo
- getTotpDeviceBy() : TotpDeviceOptionalDto
- Operation getTotpDeviceBy
- getTotpDeviceByAsync() : PromiseInterface
- Operation getTotpDeviceByAsync
- getTotpDeviceByAsyncWithHttpInfo() : PromiseInterface
- Operation getTotpDeviceByAsyncWithHttpInfo
- getTotpDeviceByRequest() : Request
- Create request for operation 'getTotpDeviceBy'
- getTotpDeviceByWithHttpInfo() : array<string|int, mixed>
- Operation getTotpDeviceByWithHttpInfo
- getTotpDeviceCode() : TotpDeviceCodeDto
- Operation getTotpDeviceCode
- getTotpDeviceCodeAsync() : PromiseInterface
- Operation getTotpDeviceCodeAsync
- getTotpDeviceCodeAsyncWithHttpInfo() : PromiseInterface
- Operation getTotpDeviceCodeAsyncWithHttpInfo
- getTotpDeviceCodeRequest() : Request
- Create request for operation 'getTotpDeviceCode'
- getTotpDeviceCodeWithHttpInfo() : array<string|int, mixed>
- Operation getTotpDeviceCodeWithHttpInfo
- getTotpDeviceRequest() : Request
- Create request for operation 'getTotpDevice'
- getTotpDeviceWithHttpInfo() : array<string|int, mixed>
- Operation getTotpDeviceWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createTotpDeviceForCustom' => ['application/json'], 'createTotpDeviceForOtpAuthUrl' => ['application/json'], 'getTotpDevice' => ['application/json'], 'getTotpDeviceBy' => ['application/json'], 'getTotpDeviceCode' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —createTotpDeviceForCustom()
Operation createTotpDeviceForCustom
public
createTotpDeviceForCustom(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForCustom'][0] ]) : TotpDeviceDto
Create a TOTP device from custom options
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
create_totp_device_otp_auth_url_options (required)
- $contentType : string = self::contentTypes['createTotpDeviceForCustom'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForCustom'] to see the possible values for this operation
Tags
Return values
TotpDeviceDto —createTotpDeviceForCustomAsync()
Operation createTotpDeviceForCustomAsync
public
createTotpDeviceForCustomAsync(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForCustom'][0] ]) : PromiseInterface
Create a TOTP device from custom options
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
(required)
- $contentType : string = self::contentTypes['createTotpDeviceForCustom'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForCustom'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTotpDeviceForCustomAsyncWithHttpInfo()
Operation createTotpDeviceForCustomAsyncWithHttpInfo
public
createTotpDeviceForCustomAsyncWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForCustom'][0] ]) : PromiseInterface
Create a TOTP device from custom options
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
(required)
- $contentType : string = self::contentTypes['createTotpDeviceForCustom'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForCustom'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTotpDeviceForCustomRequest()
Create request for operation 'createTotpDeviceForCustom'
public
createTotpDeviceForCustomRequest(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForCustom'][0] ]) : Request
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
(required)
- $contentType : string = self::contentTypes['createTotpDeviceForCustom'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForCustom'] to see the possible values for this operation
Tags
Return values
Request —createTotpDeviceForCustomWithHttpInfo()
Operation createTotpDeviceForCustomWithHttpInfo
public
createTotpDeviceForCustomWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForCustom'][0] ]) : array<string|int, mixed>
Create a TOTP device from custom options
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
(required)
- $contentType : string = self::contentTypes['createTotpDeviceForCustom'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForCustom'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TotpDeviceDto, HTTP status code, HTTP response headers (array of strings)
createTotpDeviceForOtpAuthUrl()
Operation createTotpDeviceForOtpAuthUrl
public
createTotpDeviceForOtpAuthUrl(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0] ]) : TotpDeviceDto
Create a TOTP device from an OTP Auth URL
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
create_totp_device_otp_auth_url_options (required)
- $contentType : string = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForOtpAuthUrl'] to see the possible values for this operation
Tags
Return values
TotpDeviceDto —createTotpDeviceForOtpAuthUrlAsync()
Operation createTotpDeviceForOtpAuthUrlAsync
public
createTotpDeviceForOtpAuthUrlAsync(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0] ]) : PromiseInterface
Create a TOTP device from an OTP Auth URL
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
(required)
- $contentType : string = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForOtpAuthUrl'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTotpDeviceForOtpAuthUrlAsyncWithHttpInfo()
Operation createTotpDeviceForOtpAuthUrlAsyncWithHttpInfo
public
createTotpDeviceForOtpAuthUrlAsyncWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0] ]) : PromiseInterface
Create a TOTP device from an OTP Auth URL
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
(required)
- $contentType : string = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForOtpAuthUrl'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTotpDeviceForOtpAuthUrlRequest()
Create request for operation 'createTotpDeviceForOtpAuthUrl'
public
createTotpDeviceForOtpAuthUrlRequest(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0] ]) : Request
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
(required)
- $contentType : string = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForOtpAuthUrl'] to see the possible values for this operation
Tags
Return values
Request —createTotpDeviceForOtpAuthUrlWithHttpInfo()
Operation createTotpDeviceForOtpAuthUrlWithHttpInfo
public
createTotpDeviceForOtpAuthUrlWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0] ]) : array<string|int, mixed>
Create a TOTP device from an OTP Auth URL
Parameters
- $create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions
-
(required)
- $contentType : string = self::contentTypes['createTotpDeviceForOtpAuthUrl'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTotpDeviceForOtpAuthUrl'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TotpDeviceDto, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getTotpDevice()
Operation getTotpDevice
public
getTotpDevice(string $id[, string $contentType = self::contentTypes['getTotpDevice'][0] ]) : TotpDeviceDto
Get a TOTP device by ID
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getTotpDevice'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDevice'] to see the possible values for this operation
Tags
Return values
TotpDeviceDto —getTotpDeviceAsync()
Operation getTotpDeviceAsync
public
getTotpDeviceAsync(string $id[, string $contentType = self::contentTypes['getTotpDevice'][0] ]) : PromiseInterface
Get a TOTP device by ID
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTotpDevice'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDevice'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTotpDeviceAsyncWithHttpInfo()
Operation getTotpDeviceAsyncWithHttpInfo
public
getTotpDeviceAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTotpDevice'][0] ]) : PromiseInterface
Get a TOTP device by ID
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTotpDevice'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDevice'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTotpDeviceBy()
Operation getTotpDeviceBy
public
getTotpDeviceBy([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['getTotpDeviceBy'][0] ]) : TotpDeviceOptionalDto
Get a TOTP device by username, issuer, or name. Returns empty if not found.
Parameters
- $name : string = null
-
Optional name filter (optional)
- $issuer : string = null
-
Optional issuer filter (optional)
- $username : string = null
-
Optional username filter (optional)
- $contentType : string = self::contentTypes['getTotpDeviceBy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceBy'] to see the possible values for this operation
Tags
Return values
TotpDeviceOptionalDto —getTotpDeviceByAsync()
Operation getTotpDeviceByAsync
public
getTotpDeviceByAsync([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['getTotpDeviceBy'][0] ]) : PromiseInterface
Get a TOTP device by username, issuer, or name. Returns empty if not found.
Parameters
- $name : string = null
-
Optional name filter (optional)
- $issuer : string = null
-
Optional issuer filter (optional)
- $username : string = null
-
Optional username filter (optional)
- $contentType : string = self::contentTypes['getTotpDeviceBy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceBy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTotpDeviceByAsyncWithHttpInfo()
Operation getTotpDeviceByAsyncWithHttpInfo
public
getTotpDeviceByAsyncWithHttpInfo([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['getTotpDeviceBy'][0] ]) : PromiseInterface
Get a TOTP device by username, issuer, or name. Returns empty if not found.
Parameters
- $name : string = null
-
Optional name filter (optional)
- $issuer : string = null
-
Optional issuer filter (optional)
- $username : string = null
-
Optional username filter (optional)
- $contentType : string = self::contentTypes['getTotpDeviceBy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceBy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTotpDeviceByRequest()
Create request for operation 'getTotpDeviceBy'
public
getTotpDeviceByRequest([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['getTotpDeviceBy'][0] ]) : Request
Parameters
- $name : string = null
-
Optional name filter (optional)
- $issuer : string = null
-
Optional issuer filter (optional)
- $username : string = null
-
Optional username filter (optional)
- $contentType : string = self::contentTypes['getTotpDeviceBy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceBy'] to see the possible values for this operation
Tags
Return values
Request —getTotpDeviceByWithHttpInfo()
Operation getTotpDeviceByWithHttpInfo
public
getTotpDeviceByWithHttpInfo([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['getTotpDeviceBy'][0] ]) : array<string|int, mixed>
Get a TOTP device by username, issuer, or name. Returns empty if not found.
Parameters
- $name : string = null
-
Optional name filter (optional)
- $issuer : string = null
-
Optional issuer filter (optional)
- $username : string = null
-
Optional username filter (optional)
- $contentType : string = self::contentTypes['getTotpDeviceBy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceBy'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TotpDeviceOptionalDto, HTTP status code, HTTP response headers (array of strings)
getTotpDeviceCode()
Operation getTotpDeviceCode
public
getTotpDeviceCode(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['getTotpDeviceCode'][0] ]) : TotpDeviceCodeDto
Get a TOTP device code by device ID
Parameters
- $id : string
-
ID of the TOTP device to get the code for (required)
- $at : DateTime = null
-
Optional time to get code for. If not provided, current time is used. (optional)
- $min_seconds_until_expire : int = 5
-
Optional minimum time until code expires. Will hold thread open until period reached. (optional, default to 5)
- $contentType : string = self::contentTypes['getTotpDeviceCode'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceCode'] to see the possible values for this operation
Tags
Return values
TotpDeviceCodeDto —getTotpDeviceCodeAsync()
Operation getTotpDeviceCodeAsync
public
getTotpDeviceCodeAsync(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['getTotpDeviceCode'][0] ]) : PromiseInterface
Get a TOTP device code by device ID
Parameters
- $id : string
-
ID of the TOTP device to get the code for (required)
- $at : DateTime = null
-
Optional time to get code for. If not provided, current time is used. (optional)
- $min_seconds_until_expire : int = 5
-
Optional minimum time until code expires. Will hold thread open until period reached. (optional, default to 5)
- $contentType : string = self::contentTypes['getTotpDeviceCode'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceCode'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTotpDeviceCodeAsyncWithHttpInfo()
Operation getTotpDeviceCodeAsyncWithHttpInfo
public
getTotpDeviceCodeAsyncWithHttpInfo(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['getTotpDeviceCode'][0] ]) : PromiseInterface
Get a TOTP device code by device ID
Parameters
- $id : string
-
ID of the TOTP device to get the code for (required)
- $at : DateTime = null
-
Optional time to get code for. If not provided, current time is used. (optional)
- $min_seconds_until_expire : int = 5
-
Optional minimum time until code expires. Will hold thread open until period reached. (optional, default to 5)
- $contentType : string = self::contentTypes['getTotpDeviceCode'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceCode'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTotpDeviceCodeRequest()
Create request for operation 'getTotpDeviceCode'
public
getTotpDeviceCodeRequest(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['getTotpDeviceCode'][0] ]) : Request
Parameters
- $id : string
-
ID of the TOTP device to get the code for (required)
- $at : DateTime = null
-
Optional time to get code for. If not provided, current time is used. (optional)
- $min_seconds_until_expire : int = 5
-
Optional minimum time until code expires. Will hold thread open until period reached. (optional, default to 5)
- $contentType : string = self::contentTypes['getTotpDeviceCode'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceCode'] to see the possible values for this operation
Tags
Return values
Request —getTotpDeviceCodeWithHttpInfo()
Operation getTotpDeviceCodeWithHttpInfo
public
getTotpDeviceCodeWithHttpInfo(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['getTotpDeviceCode'][0] ]) : array<string|int, mixed>
Get a TOTP device code by device ID
Parameters
- $id : string
-
ID of the TOTP device to get the code for (required)
- $at : DateTime = null
-
Optional time to get code for. If not provided, current time is used. (optional)
- $min_seconds_until_expire : int = 5
-
Optional minimum time until code expires. Will hold thread open until period reached. (optional, default to 5)
- $contentType : string = self::contentTypes['getTotpDeviceCode'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDeviceCode'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TotpDeviceCodeDto, HTTP status code, HTTP response headers (array of strings)
getTotpDeviceRequest()
Create request for operation 'getTotpDevice'
public
getTotpDeviceRequest(string $id[, string $contentType = self::contentTypes['getTotpDevice'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTotpDevice'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDevice'] to see the possible values for this operation
Tags
Return values
Request —getTotpDeviceWithHttpInfo()
Operation getTotpDeviceWithHttpInfo
public
getTotpDeviceWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTotpDevice'][0] ]) : array<string|int, mixed>
Get a TOTP device by ID
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTotpDevice'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTotpDevice'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TotpDeviceDto, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options