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
- application/json
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
- 400
- 401
Successful authentication
- application/json
- Schema
- Example (from schema)
Schema
token string
Authentication token
{
"token": "string"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
message string
Details about the error
{
"message": "string"
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
error string
extras object
status number
message string
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
Loading...