API RESET PASSWORD

[baseUrl]/api/sync/v1/ResetPassword

Descrizione

L'API permette di richiedere una mail per effettuare il reset della password. Sono possibili 2 funzionamenti diversi:

1. Invio mail con link di XOX per effettuare il reset
2. Invio mail con OTP da verificare per procedere con il reset tramite API

Parametri Richiesta

Field	Type	Required	Default	Description	Notes
Username	string		null	Username
ResetType	int		1	Tipo di mail da inviare	Valori possibili: 1 - Mail con link verso XOX per reset password 2 - Mail con OTP da verificare con chiamata successiva
OTPLength	int		5	Lunghezza del codice OTP	Valore predefinito: 5

Esempio Richiesta

curl --location '[baseUrl]/api/sync/v1/ResetPassword' \
--header 'Content-Type: application/json' \
--data '{
    "Username":"username",
    "ResetType": 2,
    "OTPLength": 4
}'

Risposta

Esito positivo

JSON

{
  "statusCode": 200,
  "errorCode": null,
  "message": null,
  "result": {
    "totalCount": 0,
    "totalPages": 0,
    "page": 0,
    "count": 0,
    "records": null,
    "record": {
      "Token": "18c3c16f2039496c9298f2e81fd3942f",
      "Expiration": "2024-10-17T09:18:34.2983379+02:00"
    }
  },
  "debug": null
}

Mail non presente

Se non è presente nessuna mail configurata per l'utente, viene restituito il seguente risultato:

JSON

{
  "statusCode": 521,
  "errorCode": "5x021",
  "message": "Reset password mail failed.",
  "result": null,
  "debug": null
}