Ein neues Benutzerkonto erstellen¶

Note

Der Body enthält die Attribute id, created und modified nicht. Die Werte dieser Attribute werden vom System nach dem Erstellen des Eintrags gesetzt.

Note

Der Body darf nur die genannten Attribute enthalten. Alle anderen möglichen Attribute des Objekts UserVO werden ignoriert.

Senden einer POST-Anfrage an den Endpunkt /users.

Beschreibung¶

Mit der Create-User-Anfrage erstellen Sie ein neues Benutzerkonto für die Organisation.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: UserVO

Anfrage¶

Um ein neues Benutzerkonto für die Organisation zu erstellen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.

Für eine detaillierte Spezifikation, welche Informationen zum Erstellen eines neuen Benutzerkontos erforderlich sind, müssen im Body ein oder mehrere Objekte UserVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`email`	Die E-Mail-Adresse des Benutzerkontos.	`string`
`login`	Der Benutzername für die Anmeldung in der Myra App. Dieser sollte mit dem Wert für email übereinstimmen.	`string`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`firstname`	Der Vorname des Benutzers.	`string`
`lastname`	Der Name des Benutzers.
`roles`	Ein Array mit den Berechtigungsrollen für das Benutzerkonto.	`ADMINISTRATOR` `USER`
`rootGroupRoles`	Ein Array mit Informationen zu den Gruppenberechtigungen für das Benutzerkonto.	`ADMINISTRATOR` `USER`
`isIndirectCustomer`	Legt fest, ob das Benutzerkonto ein Benutzerkonto eines Partners oder eines Direktkunden von Myra sein soll.	`true` `false`

Das System gibt als Antwort das Objekt UserVO mit den Informationen zum neuen Eintrag zurück.

Beispiel¶

Beispiel-Request-Body:

{
  "email": "string",
  "login": "string",
  "firstname": "string",
  "lastname": "string",
  "roles": "ADMINISTRATOR",
  "rootGroupRoles": "ADMINISTRATOR",
  "isIndirectCustomer": true
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
201	Das neu erstellte `UserVO`.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.