Update User

Übersicht über den Endpunkt „Benutzer aktualisieren“ zum Ändern lokaler Benutzerinformationen, einschließlich erforderlicher Scopes

Aktualisiert die Informationen über den angegebenen lokalen Benutzer.

API-Endpunkt

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

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

Parameter	Datentyp	Beschreibung
userId (erforderlich)	String	Die ID des Benutzers, den Sie aktualisieren möchten.

Anforderungstext

Der Anforderungstext enthält die Benutzerinformationen, die Sie aktualisieren möchten, z. B. Name, E-Mail-Adresse oder Gruppenmitgliedschaft.

{
  "name": "string",
  "surname": "string",
  "email": "[e-mail]",
  "isActive": true,
  "password": "string",
  "groupIDsToAdd": [
    "string"
  ],
  "groupIDsToRemove": [
    "string"
  ],
  "bypassBasicAuthRestriction": true,
  "invitationAccepted": true
}

Antworten

200 OK

Die benutzerdefinierte Gruppe wird mit den von Ihnen angegebenen Informationen aktualisiert.

400 Ungültige Anforderung

Das Update konnte nicht ausgeführt 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} lautet: https://{yourDomain}/identity
• Ihre {access_token} ist: 1234 (aus Gründen der Länge).
• Sie möchten die Informationen und die Mitgliedschaft der Benutzer-ID her-1909 aktualisieren.

Der Aufruf sollte dem folgenden Beispiel ähneln (cURL):

curl --location --request PUT 'https://{yourDomain}/identity/api/User/her-1909' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "name": "Hermione",
    "surname": "Granger-Weasley",
    "email": "[e-mail]",
    "groupIDsToAdd": [
        "gryff-01",
        "alumni-02",
        "teachers-03"
    ],
    "groupIDsToRemove": [],
    "bypassBasicAuthRestriction": false
}'

Hier ist die Antwort für einen erfolgreichen Aufruf:

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