Skip to main content
API docs by Redocly

Smart-MFA API (1.0.0)

Download OpenAPI specification:Download

Called by the identity provider for multi-factor authentication of users. SmartBridge sends a QR code for use in enabling MFA for a user's account, and validates the one time passcode entered by the user on subsequent multi-factor logins.

Disclaimer: This is an API that is restricted and only usable by the IdP and is not available to the public.

default

Generates MFA QR code

Generates the QR code used to enable MFA on a user's account and allow the user to access their time-based one time passcode.

Request Body schema: application/json

A unique key for identifying the user and an account name for that user.

key
required
string
account_name
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "uniqueUserId123",
  • "account_name": "userAccount"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Validates a one time passcode

Validates the six-digit time-based one time passcode entered by the user.

Request Body schema: application/json
key
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "uniqueUserId123",
  • "code": 123456
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

deletes the mfa credential for a user

Deletes the mfa credential for a user based on the given key

query Parameters
key
string
Example: key=uniqueUserId

The key used to create the mfa credential

Responses

Response samples

Content type
application/json
{
  • "success": true
}