Das Passwort eines Benutzerkontos ändern¶

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/{id}/password.

Beschreibung¶

Mit der Change-Password-Anfrage ändern Sie das Passwort eines Benutzerkontos der Organisation.

Voraussetzungen¶

Werte der Anfrage: User-ID {id}

Objekte: PasswordVO

Anfrage¶

Um das Passwort eines Benutzerkontos zu ändern, fügen Sie die User-ID {id} dem Pfad der Anfrage hinzu.

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

Attribut	Beschreibung	Werte
`oldPassword`	Das aktuelle Passwort.	`string`
`newPassword`	Das neu zu erstellende Passwort.	`string`
`confirmPassword`	Bestätigung des neuen Passworts.	`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:

{
  "oldPassword": "string",
  "newPassword": "string",
  "confirmPassword": "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.