Mfa

To perform authorization using an MFA token, users must first obtain an MFA secret code and configure their authentication application.

Generate MFA Secret Code

The HTTP POST request to the /Mfa/GenerateMfaCode path retrieves an MFA secret code that must be used to configure MFA for a user.

SecurityuserAuth or clientAuth
Request
Request Body schema: application/json
mfaToken
string or null

MFA token.

Responses
200

OK

400

Bad request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized request. The authorization field in the request has been expected but not found, found but expired or the MFA secret code has already been generated.

500

Internal server error.

post/api/v7.21/Mfa/GenerateMfaCode
Request samples
application/json
{
  • "mfaToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiSm9obiBEb2UiLCJpYXQiOjE1MTYyMzkwMjJ9.hqWGSaFpvbrXkOWc6lrnffhNWR19W_S1YKFBx2arWBk"
}
Response samples
application/json
{
  • "mfaKey": "HBIG4FZN5XM7RGZCYWM76EGEYLFZ6OYK",
  • "mfaQrCodeUrl": "otpauth://totp/domain%5CAdministrator?secret=HBIG4FZN5XM7RGZCYWM76E111LFZ6OYK&issuer=Machine Name"
}