Création d’un tenant via l’API Vantage

Provisionnez par programmation un nouveau tenant ABBYY Vantage avec l’API Vantage. Nécessite le rôle d’Opérateur d’exécution.

Un administrateur système peut attribuer le rôle d’Opérateur d’exécution à un administrateur de tenant. Une fois ce rôle attribué, l’administrateur de tenant peut créer de nouveaux tenants via l’API Vantage et attribuer également ce rôle à d’autres utilisateurs de son tenant.

Pour créer un tenant via l’API Vantage, un Opérateur d’exécution doit procéder comme suit :

1. S’authentifier auprès de l’API Vantage. Pour plus de détails, voir Authentication.
2. Envoyer une requête POST avec l’en‑tête Authorization = Bearer <access token> à {baseUrl}/api/publicapi/v1/invites/, avec les paramètres suivants dans le corps de la requête :

Paramètre	Description
Model	Un objet qui contient les paramètres suivants : useMySubscription, email, tenantName, validWithin et tenantDescription.
email	L’adresse e‑mail du nouvel administrateur de tenant.
validWithin	Délai à compter de l’envoi pendant lequel une invitation peut être acceptée. Le format est days.hours:minutes:seconds. La valeur par défaut est 14.00:00:00 (14 jours).
tenantName	Le nom du tenant. Les noms de tenants doivent être uniques. La création d’un tenant avec un nom déjà existant déclenche une erreur.
useMySubscription	Indique si l’abonnement du tenant actuel doit être réutilisé. Si cette option est activée, le tenant actuel et le nouveau tenant partagent le même compteur de consommation de pages. Lorsque ce compteur est épuisé par l’un ou l’autre tenant, les deux ne peuvent plus l’utiliser. La valeur par défaut est False, ce qui signifie qu’un nouveau fichier d’abonnement doit être téléchargé.
tenantDescription	La description du tenant. Il peut s’agir de tout texte décrivant le tenant, et elle sera visible par l’administrateur système.

​

Exemple de requête

curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'Model={
  "useMySubscription": false,
  "email": "[e-mail]",
  "tenantName": "name",
  "validWithin": "14.00:00:00",
  "tenantDescription": "description"
}' \
  --form File='@example-file'

​

Rubriques connexes

• Gestion des tenants
• Gérer les clients de l’API Vantage