[Vorschau] Benutzerkennwort ändern

Aktualisiert das Kennwort für die angegebenen Benutzer.

API-Endpunkt

https://{yourDomain}/identity/api/User/{userId}/changepassword

Scopes

Folgende Scopes sind erforderlich:

• PM.User
• PM.User.Write

Anforderungsheader

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Hinweis: Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Pfadparameter

Pfadparameter	Datentyp	Beschreibung
userId (erforderlich)	String	Die ID des Benutzers, für den Sie das Kennwort aktualisieren möchten.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, zu der der Benutzer hinzugefügt werden soll, und optional die Gruppen, denen Sie den Benutzer zuordnen möchten.

{
  "oldPassword": "string",
  "newPassword": "string"
}

Antworten

200 OK

Der Benutzer wird in der angegebenen Organisation erstellt und erhält eine ID.

400 Ungültige Anforderung

Der Benutzer konnte nicht erstellt werden.

{
    "errors": {
        "bypassBasicAuthRestriction": [
            "Unexpected character encountered while parsing value: h. Path 'bypassBasicAuthRestriction', line 17, position 35.",
            "Unexpected character encountered while parsing value: a. Path 'bypassBasicAuthRestriction', line 17, position 35."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-aec3de9099a9934e9c31e26c19f5e0dd-8c0d3d5f476c7742-00"
}

Beispielanforderung

Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.

• Ihre {baseURL} ist: https://{yourDomain}/{organizationName}/{tenantName}/
• Ihre {access_token} ist: 1234 (aus Gründen der Länge).
• Die {userId} lautet: har-3107

Der Aufruf sollte wie folgt aussehen (cURL):

curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User/har-3107/changepassword' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
  "oldPassword": "al0h0m0ra-account",
  "newPassword": "patr0nu5"
}'

Hier ist die Antwort für einen erfolgreichen Aufruf:

{
    "succeeded": true,
    "errors": []
}