Ein neues Passwort für ein Benutzerkonto erstellen¶
Note
Die Authentifizierung über einen API-Schlüssel oder eine Signatur wird für diesen Endpunkt nicht unterstützt.
Senden einer POST-Anfrage an den Endpunkt /user/password/new.
Beschreibung¶
Mit der New-Password-Anfrage erstellen Sie ein neues Passwort für ein Benutzerkonto der Organisation.
Voraussetzungen¶
Werte der Anfrage: keine
Objekte: PasswordVO
Anfrage¶
Um ein neues Passwort für ein Benutzerkonto zu erstellen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.
Für eine detaillierte Spezifikation, welche Informationen zum Erstellen eines neuen Passworts für ein Benutzerkonto erforderlich sind, muss im Body das Objekt PasswordVO mit den folgenden Attributen definiert werden:
| Attribut | Beschreibung | Werte |
|---|---|---|
newPassword |
Das neu zu erstellende Passwort. | string |
confirmPassword |
Bestätigung des neuen Passworts. | string |
token |
Das alphanumerische Token aus der E-Mail zum Zurücksetzen des Passworts, zu finden nach /new-password/. |
string |
Bei einer erfolgreichen Anfrage gibt das System ausschließlich den HTTP-Code 201 zurück.
Die Inhaberin oder der Inhaber des Benutzerkontos erhält eine E-Mail zur Bestätigung der Passwortänderung.
Beispiel¶
Beispiel-Request-Body:
Antworten¶
Die folgenden Antworten sind möglich:
| STATUSCODE | BESCHREIBUNG |
|---|---|
| 201 | Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt. |
| 400 | Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen. |
| 401 | Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war. |
| 403 | Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen. |