This API starts the Multi-Factor Authentication process. It requires the partial AuthToken from Authentication call. The Controller will initiate the flow and return details required to continue MFA.
Optional MFA initialization details.
Some MFA configurations require user password in order to authenticate the user along with the multi-factor. Otherwise not required.
MFA initialization response.
The type of the Multi-Factor Authentication.
- 'AlreadySeeded': The MFA provider is the built-in Time-based OTP provider and the user has already a seed in the system. OTP is required on the next step.
- 'Secret': The MFA provider is the built-in Time-based OTP provider and this is the first time the user is doing an MFA. It includes details about the seed. OTP is required on the next step.
- 'Challenge': The MFA provider is a RADIUS provider. It might include a challenge that needs to be sent back. OTP is required on the next step.
- 'Push': The MFA provider is a RADIUS provider but the authentication is done externally, such as a mobile app that prompts. Send a dummy OTP right away to trigger the external authentication.
The seed for the built-in Time-based OTP provider. Used when configuring TOTP apps manually. Only available in Secret type.
A URL for triggering TOTP apps directly and configuring an entry automatically. Only available in Secret type.
The barcode image in jpg format. Base64 encoded. Only available in Secret type.
A message from the RADIUS MFA provider. Only available in Challenge type.
State send by the RADIUS MFA provider as challenge. It needs to be sent back during MFA authentication. Only available in Challenge type.
How long the Controller wait for RADIUS response. Especially useful for external authentication mechanism. Clients waiting shorter than this timeout will fail with a wrong error. Only available in Challenge and Push type.
Whether the RADIUS MFA provider expecting the user password for authentication. If true, the user password needs to be sent as otp instead of a dummy value. Only available in Push type.
JSON error. Check the JSON format.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Token error. Login again.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Invalid 'Accept' header.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Request validation error. Check "errors" array for details.
Http 422 error for object validation.
Machine readable error code.
Human readable error details.
List of fields with validation errors.
Name of the field that failed validation.
Failure reason.
Unexpected server side error.
Generic HTTP error.
Machine readable error code.
Human readable error details.