Sofar logo
Sofar logo
Api
Activate email OTP POSTActivate TOTP POSTGet active 2FA methods GETSet or reset email OTP POSTInitiate email OTP challenge POSTInitiate an email address transfer POSTSet or reset TOTP POSTTime until the next email OTP may be generated GETSend a password reset email POSTComplete an email address transfer PUTTime until the next recovery code guess GETDeactivate email OTP DELETEDeactivate TOTP DELETEReset the recovery codes of a user POSTSend a password reset OTP POSTTime until the next TOTP guess GETUpdate password via OTP PUTUpdate password via sudo token PUTCheck a password reset OTP POSTComplete email OTP challenge POSTVerify a recovery code POSTVerify TOTP code POST
User
POST
/user/2fa/email-otp/setup

Authorization

AuthorizationBearer <token>

In: header

Get active 2FA methods GET

Get an object with the active 2FA methods for your account and when they were enabled

Initiate email OTP challenge POST

Providing an access token, send an email OTP which can be used to acquire a sudo token

Query Parameters

origin?string

The mail configuration which should be used to send the email

Lengthlength <= 256
language?string

The language which should be used for sending the email

Length2 <= length <= 2

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://authentication.eniris.be/user/2fa/email-otp/setup" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
null
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid email address"
}
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "NO_TOKEN_PROVIDED"
}
{
  "statusCode": 429,
  "retryAfter": 0,
  "error": "Too many requests",
  "message": "TOO_MANY_OTP_EMAILS"
}
{
  "statusCode": 500,
  "error": "Internal server error",
  "message": "UNABLE_TO_FIND_MAIL_TEMPLATE"
}

Providing a sudo token or an access token (if 2FA is disabled), configure a mail address for email OTP

A valid sudo token (proof of presence) can be obtained via the /2fa/{method}/verify endpoints. It has a 5 minutes validity period.

email*string
Formatemail
Lengthlength <= 256