Nutzenden aus einer Organisation entfernen¶

Note

Nutzende können ihr eigenes Konto unabhängig von ihrer Rolle nicht aus einer Organisation entfernen; ein entsprechender Versuch liefert die Antwort 403.

Senden einer POST-Anfrage an den Endpunkt /organisations/{organisation}/users/remove.

Beschreibung¶

Mit der Remove-Organisation-User-Anfrage entfernen Sie einen Nutzenden aus einer angegebenen Organisation.

Voraussetzungen¶

Werte der Anfrage: Organisations-ID {organisation}

Objekte: keine

Anfrage¶

Um einen Nutzenden aus einer Organisation zu entfernen, fügen Sie die Organisations-ID {organisation} in den Pfad der Anfrage ein.

Für eine detaillierte Spezifikation, welche Informationen zum Entfernen eines Nutzenden aus der Organisation erforderlich sind, muss im Body das folgende Attribut definiert werden:

Attribut	Beschreibung	Werte
`userId`	Die ID des zu entfernenden Nutzenden.	`string`

Als Ergebnis erhalten Sie ein Objekt mit einer Bestätigungsmeldung.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`message`	Die Bestätigungsmeldung, die nach dem Entfernen des Nutzenden zurückgegeben wird.	`string`

Beispiel¶

Beispiel-Request-Body:

{
  "userId": "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.
404	Die Anfrage war nicht erfolgreich, da die angeforderte Ressource nicht gefunden wurde.