Zum Hauptinhalt springen
Ein Systemadministrator kann einem Mandantenadministrator die Rolle „Fulfillment Operator“ zuweisen. Mit dieser Rolle kann der Mandantenadministrator über die Vantage-API weitere Mandanten zum System hinzufügen sowie diese Rolle anderen Benutzern im Mandanten zuweisen. Um einen Mandanten über die Vantage-API zu erstellen, muss ein Fulfillment Operator Folgendes tun:
  1. Sich an der Vantage-API authentifizieren, siehe Authentication für Details.
  2. Eine POST-Anfrage mit dem Header Authorization = Bearer <access token> an {baseUrl}/api/publicapi/v1/invites/ senden, mit folgenden Parametern im Request-Body:
ParameterBeschreibung
emailE-Mail-Adresse des neu erstellten Mandantenadministrators.
validWithinZeitraum ab Versand, innerhalb dessen eine Einladung angenommen werden kann. Format: days.hours:minutes:seconds. Der Standardwert ist „14.00:00:00“ (14 Tage).
tenantNameName des Mandanten. Mandantennamen sind systemweit eindeutig. Wenn der angegebene Name bereits von einem anderen Mandanten verwendet wird, tritt beim Versuch, einen neuen Mandanten mit demselben Namen zu erstellen, ein Fehler auf.
useMySybscriptionGibt an, ob das Abonnement des aktuellen Mandanten verwendet wird. Wenn das Abonnement des aktuellen Mandanten verwendet wird, nutzen beide Mandanten (der aktuelle und der neue) Seiten aus demselben Zähler. Wenn einer der Mandanten alle verbleibenden Seiten dieses Zählers verbraucht, können danach beide Mandanten ihn nicht mehr verwenden. Der Standardwert ist False, d. h. eine neue Abonnementdatei muss heruntergeladen werden.
tenantDescriptionBeschreibung des Mandanten. Eine beliebige Zeichenfolge, die den Mandanten beschreibt. Diese Zeichenfolge wird dem Systemadministrator angezeigt.
Beispielanfrage:

​
Unter Windows

curl --location --request POST "{baseUrl}/api/publicapi/v1/invites/" 
-H "accept: application/json" \
-H "Authorization: Bearer {token}"
{ 
  "email": "[email protected]",
  "validWithin": "14.00:00:00", 
  "tenantName": "Name des Mandanten",
  "useMySubscription": true,
  "tenantDescription": "Beschreibung des Mandanten"
}

​
Unter Linux

curl --location --request POST '{baseUrl}/api/publicapi/v1/invites/'
-H 'accept: application/json' \
-H 'Authorization: Bearer {token}'
{ 
  'email': '[email protected]',
  'validWithin': '14.00:00:00', 
  'tenantName': 'Name des Mandanten',
  'useMySubscription': true,
  'tenantDescription': 'Beschreibung des Mandanten'
}