Zum Hauptinhalt springen
Ein Systemadministrator kann einem Tenant-Administrator die Rolle Fulfillment Operator zuweisen. Mit dieser Rolle kann der Tenant-Administrator weitere Tenants über die Vantage-API zum System hinzufügen sowie diese Rolle anderen Benutzern im Tenant zuweisen. Um einen Tenant über die Vantage-API zu erstellen, muss ein Fulfillment Operator Folgendes tun:
  1. Bei 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 den folgenden Request-Body-Parametern:
ParameterBeschreibung
emailDie E-Mail-Adresse des neu erstellten Tenant-Administrators.
validWithinZeitraum ab dem Versand, innerhalb dessen eine Einladung angenommen werden kann. Format: days.hours:minutes:seconds. Der Standardwert des Parameters ist “14.00:00:00” (14 Tage).
tenantNameName des Tenants. Tenant-Namen sind innerhalb des Systems eindeutig. Wenn der angegebene Name bereits von einem anderen Tenant verwendet wird, tritt beim Versuch, einen neuen Tenant mit demselben Namen zu erstellen, ein Fehler auf.
useMySybscriptionGibt an, ob das Abonnement des aktuellen Tenants verwendet wird. Wenn das Abonnement des aktuellen Tenants verwendet wird, nutzen beide Tenants (der aktuelle und der neue) Seiten aus demselben Zähler. Wenn einer der Tenants alle verbleibenden Seiten dieses Zählers aufbraucht, können beide Tenants ihn anschließend nicht mehr verwenden. Der Standardwert des Parameters ist False, was bedeutet, dass eine neue Abonnementdatei heruntergeladen werden muss.
tenantDescriptionBeschreibung des Tenants. Beliebiger Text (string), der den Tenant beschreibt. Dieser Text 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": "admin@company.tld",
  "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': 'admin@company.tld',
  'validWithin': '14.00:00:00', 
  'tenantName': 'Name des Mandanten',
  'useMySubscription': true,
  'tenantDescription': 'Beschreibung des Mandanten'
}