Nutzende zur Organisation hinzufügen¶

Note

Die Attribute userId und userFullName sind für Myra-Deployments erforderlich.

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

Beschreibung¶

Mit der Add-Organisation-User-Anfrage fügen Sie einer angegebenen Organisation Nutzende hinzu.

Voraussetzungen¶

Werte der Anfrage: Organisation-ID {organisation}

Objekte: UserVO

Anfrage¶

Um der Organisation Nutzende hinzuzufügen, fügen Sie die Organisation-ID {organisation} in den Pfad der Anfrage ein.

Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen von Nutzenden erforderlich sind, muss im Body ein Objekt UserVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`userEmail`	Die E-Mail-Adresse der Nutzenden.	`string`
`userRole`	Die Rolle der Nutzenden.	`admin` `editor`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`userId` (erforderlich bei Myra-Deployments)	Die MyraCloud-ID der Nutzenden.	`integer`
`userFullName` (erforderlich bei Myra-Deployments)	Der vollständige Name der Nutzenden.	`string`

Als Ergebnis gibt das System das Objekt message zurück, das bestätigt, dass die Nutzenden hinzugefügt wurden.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`message`	Die Bestätigungsmeldung der Anfrage.	`string`

Beispiel¶

Beispiel-Request-Body:

{
  "userEmail": "string",
  "userRole": "string",
  "userId": 0,
  "userFullName": "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.