Nutzende innerhalb einer Organisation ändern

Note

Der Body muss die Attribute id und modified enthalten, um den entsprechenden Eintrag zu identifizieren.

Note

Die ID des Eintrags im Pfad der Anfrage muss mit dem Wert des Attributs id im Body übereinstimmen.

Senden einer PATCH-Anfrage an den Endpunkt /organisations/{organisation}/users/{user}.

Beschreibung

Mit der Update-Organisation-User-Anfrage ändern Sie den Namen und die Rolle von Nutzenden innerhalb einer bestimmten Organisation.

Voraussetzungen

Werte der Anfrage: Organisation-ID {organisation}; Benutzer-ID {user}

Objekte: keine

Anfrage

Um Nutzende innerhalb einer Organisation zu ändern, fügen Sie die Organisation-ID {organisation} und die Benutzer-ID {user} in den Pfad der Anfrage ein.

Für eine detaillierte Spezifikation, welche Informationen zum Ändern von Nutzenden erforderlich sind, müssen die folgenden Attribute im Body definiert werden:

Attribut	Beschreibung	Werte
id	Die ID des Nutzenden.	string
modified	Das Datum der letzten Änderung im ISO-8601-Format.	string($date-time)

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
name	Der neue Name des Nutzenden.	string
role	Die neue Rolle des Nutzenden.	admin editor

Als Ergebnis erhalten Sie ein Objekt mit den angefragten Informationen.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
id	Die ID des Nutzenden.	string
name	Der Name des Nutzenden.	string
email	Die E-Mail-Adresse des Nutzenden.	string
status	Der aktuelle Status des Nutzenden.	string
invitedSince	Das Datum, an dem der Nutzende eingeladen wurde, oder leer, wenn die Einladung bereits angenommen wurde.	string
role	Die Rolle des Nutzenden innerhalb der Organisation.	admin editor

Beispiel

Beispiel-Request-Body:

{
  "name": "string",
  "role": "string"
}

Antworten

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.
422	Die Anfrage war nicht erfolgreich, da die übermittelten Daten nicht verarbeitet werden konnten.