Das Passwort eines Benutzerkontos zurücksetzen¶

Note

Die Authentifizierung über einen API-Schlüssel, eine Signatur oder ein API-Token wird für diesen Endpunkt nicht unterstützt.

Senden einer POST-Anfrage an den Endpunkt /user/password/reset.

Beschreibung¶

Mit der Reset-Password-Anfrage setzen Sie das Passwort eines Benutzerkontos der Organisation zurück.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: ResetPasswordVO

Anfrage¶

Um das Passwort eines Benutzerkontos zurückzusetzen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.

Für eine detaillierte Spezifikation, welche Informationen zum Zurücksetzen des Passworts eines Benutzerkontos erforderlich sind, muss im Body das Objekt ResetPasswordVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`email`	Die E-Mail-Adresse des Benutzerkontos, dessen Passwort zurückgesetzt werden soll.	`string`

Bei einer erfolgreichen Anfrage gibt das System ausschließlich den HTTP-Code 200 zurück.

Die Inhaberin oder der Inhaber des Benutzerkontos erhält eine E-Mail zum Zurücksetzen des Passworts.

Beispiel¶

Beispiel-Request-Body:

{
  "email": "string"
}

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.