Provide Multi-Factor Authentication

POST 
/mfa

Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.

Request

Header Parameters

Device-ID string

Identifier of the device

*/*

Body

required

MFA request data

mfa_code stringrequired

Multi-factor authentication code

remember_me boolean

Boolean flag to remember the user

recaptcha_token string

Token for reCAPTCHA validation. ReCAPTCHA token is required unless the DISABLE_RECAPTCHA configuration is set to true.

Responses

200

Successful authentication

application/json

Schema

Schema

token string

Authentication token

Example (from schema)

{
  "token": "string"
}

400

Bad Request

application/json

Schema

Schema

error string

Details about the error

extras

object

object

Example (from schema)

{
  "error": "Invalid input",
  "extras": {
    "field_foo": "field_foo is required",
    "field_bar": "field_bar needs to be an integer"
  }
}

401

Unauthorized

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Loading...