Api
Activate email OTP POST
Activate TOTP POST
Get active 2FA methods GET
Set or reset email OTP POST
Initiate email OTP challenge POST
Initiate an email address transfer POST
Set or reset TOTP POST
Time until the next email OTP may be generated GET
Send a password reset email POST
Complete an email address transfer PUT
Time until the next recovery code guess GET
Deactivate email OTP DELETE
Deactivate TOTP DELETE
Reset the recovery codes of a user POST
Send a password reset OTP POST
Time until the next TOTP guess GET
Update password via OTP PUT
Update password via sudo token PUT
Check a password reset OTP POST
Complete email OTP challenge POST
Verify a recovery code POST
Verify TOTP code POST
Sofar logo
Sofar logo
User
POST
/v1/auth/forgot-password

Send a password reset email to an existing user. Wait at least 60 seconds between successive calls

Authorization

accessBearerAuth
AuthorizationBearer <token>

In the value field below, fill in the access token. It has a 10 minutes validity period. A valid token can be obtained via the /accesstoken endpoint (call), AFTER authorization with refreshBearerAuth and the refresh token.

In: header

Query Parameters

origin?string

The mail configuration which should be used to send the email

language?string

The language which should be used for sending the email

Request Body

application/json

The email address to send the password reset link to

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.eniris.be/v1/auth/forgot-password" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
null
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Missing or misformatted query parameter or body"
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Forbidden email provider"
}
{
  "statusCode": 429,
  "error": "Too many requests",
  "message": "Last password forgot call was too recent"
}

Time until the next email OTP may be generated GET

Get the minimum time until the next OTP can be sent

Complete an email address transfer PUT

Complete an account email transfer

email*string
Formatemail
Length5 <= length <= 100