Sur cette page
> ressources > documentation > api > Référence de l’API : organisations

Référence de l’API : organisations

warning

La suppression d’un environnement efface définitivement tous ses processus, jeux de données et affectations d’utilisateurs. Cette opération est irréversible. Vous ne pouvez pas supprimer l’environnement utilisé pour vous authentifier.

warning

Retirer un utilisateur de l’organisation lui enlève l’accès à tous les environnements de cette organisation.

Les organisations regroupent plusieurs environnements au sein d’une même entité.

Récupérer l’organisation associée à l’environnement

Consultable avec une clé API limitée à l’environnement ; une clé limitée à l’organisation est également acceptée.

Point de terminaison : GET /v1/tenant/{tenantId}/organization

Authentification : Clé API limitée à l’environnement ou à l’organisation · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid

Réponse (200) :

Détails de l’organisation

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}
Champ Type Obligatoire Description
id string Oui Format : uuid
displayName string Oui Valeur par défaut : ""
Longueur maximale : 128
createdAt string Oui Format : date-time
contactEmail string Oui Format : email
isActive boolean Oui Valeur par défaut : true
allowedLogins object Oui
createdBy string Oui Format : uuid

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Consulter la capacité de licences utilisateur de l’organisation et la règle de synchronisation automatique

Renvoie, pour chaque niveau (Process Foundation, Process Architecture, Process Intelligence), le nombre de licences utilisateur achetées et utilisées à l’échelle de l’organisation, le quota de licences de lecture gratuites, la cible de synchronisation automatique, une explication des écarts de licences (ce que fera le moteur et à quel moment), la périodicité de facturation et externalApiSeatPolicy. Consultable avec une clé API limitée à l’environnement. Le paramètre de chemin {tenantId&#125 ; désigne l’environnement de contexte (l’organisation associée à la clé limitée à l’organisation), et non la cible de l’opération.

Point de terminaison : GET /v1/tenant/{tenantId}/organization/billing/seats

Authentification : Clé API limitée à l’environnement ou à l’organisation · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid

Réponse (200) :

Capacité de licences utilisateur

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}
Champ Type Obligatoire Description
contractType free | selfServe | fixed | unlimited Oui Valeurs autorisées : free, selfServe, fixed, unlimited
isTrial boolean Oui
purchased object Oui
inUseBillable object Oui
inUseFree number Oui
inUseDashboardViewers number Oui
totalBillable number Oui
freeViewerAllowance number Oui
freeViewerOverAllowance number Oui
dashboardViewerAllowance number Oui
dashboardViewerOverAllowance number Oui
fixedOverage number Oui
target object Oui
drift object[] Oui
interval month | year Oui Valeurs autorisées : month, year
nextBilledAt string Oui
externalApiSeatPolicy autoBill | requireCapacity Oui Valeurs autorisées : autoBill, requireCapacity

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 404 Ressource introuvable

Consulter les statistiques de l’organisation

Le paramètre de chemin {tenantId&#125 ; désigne l’environnement de contexte (l’organisation associée à la clé limitée à l’organisation), et non la cible de l’opération.

Point de terminaison : GET /v1/tenant/{tenantId}/organization/statistics

Authentification : Clé API limitée à l’organisation · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid

Réponse (200) :

Statistiques de l’organisation

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}
Champ Type Obligatoire Description
userCount number Oui
tenantCount number Oui
tenantStatistics object[] Oui

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée

Lister tous les environnements de l’organisation

Le paramètre de chemin {tenantId&#125 ; désigne l’environnement de contexte (l’organisation associée à la clé limitée à l’organisation), et non la cible de l’opération.

Point de terminaison : GET /v1/tenant/{tenantId}/organization/tenants

Authentification : Clé API limitée à l’organisation · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid
limit integer requête Non Nombre maximal d’éléments à renvoyer
offset integer requête Non Nombre d’éléments à ignorer

Réponse (200) :

Liste des environnements

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"createdBy": "00000000-0000-0000-0000-000000000000",
		"createdAt": "2024-03-15T16:30:00Z",
		"displayName": "string",
		"contactEmail": "string",
		"isActive": true,
		"shortName": "string",
		"useOrganizationTheme": true,
		"description": "string",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"allowedLogins": {
			"Microsoft": true,
			"Google": true,
			"LinkedIn": true
		},
		"tenantType": "normal",
		"url": "string"
	}
]

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée

Créer un environnement dans l’organisation (nécessite une clé API limitée à l’organisation)

Le paramètre de chemin {tenantId&#125 ; désigne l’environnement de contexte (l’organisation associée à la clé limitée à l’organisation), et non la cible de l’opération.

Point de terminaison : POST /v1/tenant/{tenantId}/organization/tenants

Authentification : Clé API limitée à l’organisation · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}
Champ Type Obligatoire Description
displayName string Non Longueur maximale : 128
shortName string Oui
description string Non Longueur maximale : 200
timezone string Non Longueur maximale : 64
tenantType normal | sandbox | demo Non Valeurs autorisées : normal, sandbox, demo

Réponse (201) :

Environnement créé

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}
Champ Type Obligatoire Description
id string Oui Format : uuid
createdBy string Oui Format : uuid
createdAt string Oui Format : date-time
displayName string Oui Valeur par défaut : ""
Longueur maximale : 128
contactEmail string Oui Format : email
isActive boolean Oui Valeur par défaut : true
shortName string Oui
useOrganizationTheme boolean Oui Valeur par défaut : true
description string Oui Longueur maximale : 200
organizationId string Oui Format : uuid
allowedLogins object Oui
tenantType normal | sandbox | demo Oui Valeurs autorisées : normal, sandbox, demo
Valeur par défaut : normal
url string Oui Format : uri

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre non valide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 403 La clé API ne dispose pas de la portée ou de l’accès à l’organisation requis, l’environnement est inactif ou le forfait ne permet pas ce type de fichier
  • 406 La valeur ne peut pas être acceptée (par exemple, nom court réservé ou déjà utilisé)

Désactiver un environnement de l’organisation (suppression réversible, nécessite une clé API limitée à l’organisation)

L’accès à l’API pour cet environnement est immédiatement interrompu. L’environnement et ses données sont conservés pendant la période de sécurité précédant la suppression, puis supprimés par le processus automatisé. L’environnement que vous utilisez actuellement (l’environnement de contexte) ne peut pas être supprimé.

Point de terminaison : DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Authentification : Clé API limitée à l’organisation · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
targetId chaîne chemin Oui Format : uuid

Réponse (200) :

Environnement supprimé

{
	"success": true,
	"message": "string"
}
Champ Type Obligatoire Description
success booléen Oui
message chaîne Oui

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre non valide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 403 La clé API ne dispose pas de la portée ou de l’accès à l’organisation requis, l’environnement est inactif ou le forfait ne permet pas ce type de fichier
  • 404 Ressource introuvable

Restaurer un environnement supprimé de manière réversible dans l’organisation (nécessite une clé API limitée à l’organisation)

Annulez une suppression réversible pendant la période de sécurité : l’environnement et ses données sont rétablis à l’identique et l’accès à l’API reprend. Le paramètre de chemin {tenantId&#125 ; correspond à l’environnement de contexte (l’organisation associée à la clé limitée à l’organisation), et non à la cible de l’opération.

Point de terminaison : POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Authentification : Clé API limitée à l’organisation · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
targetId chaîne chemin Oui Format : uuid

Réponse (200) :

Environnement restauré

{
	"success": true,
	"message": "string"
}
Champ Type Obligatoire Description
success booléen Oui
message chaîne Oui

Erreurs :

  • 400 Requête incorrecte : par exemple, expression de filtre non valide, processus sans modèle, type de fichier importé non pris en charge ou champ obligatoire manquant
  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 403 La clé API ne dispose pas de la portée ou de l’accès à l’organisation requis, l’environnement est inactif ou le forfait ne permet pas ce type de fichier
  • 404 Ressource introuvable

Afficher tous les utilisateurs de l’organisation

Le paramètre de chemin {tenantId&#125 ; correspond à l’environnement de contexte (l’organisation associée à la clé limitée à l’organisation), et non à la cible de l’opération.

Point de terminaison : GET /v1/tenant/{tenantId}/organization/users

Authentification : Clé API limitée à l’organisation · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
limit entier requête Non Nombre maximal d’éléments à renvoyer
offset entier requête Non Nombre d’éléments à ignorer

Réponse (200) :

Liste des utilisateurs de l’organisation

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée

Modifier les paramètres d’un utilisateur de l’organisation (nécessite une clé API limitée à l’organisation)

Les indicateurs de rôle transmis dans le corps de la requête (isAdminInOrganization, isActiveInOrganization) sont appliqués tels quels. Réservez les clés limitées à l’organisation aux administrateurs de l’organisation. Le paramètre de chemin {tenantId&#125 ; correspond à l’environnement de contexte (l’organisation associée à la clé limitée à l’organisation), et non à la cible de l’opération.

Point de terminaison : PUT /v1/tenant/{tenantId}/organization/users/{userId}

Authentification : Clé API limitée à l’organisation · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
userId chaîne chemin Oui Format : uuid

Corps de la requête :

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Champ Type Obligatoire Description
isActiveInOrganization booléen Non Indique si l’utilisateur est actif dans l’organisation
isAdminInOrganization booléen Non Droits d’administration de l’organisation (appliqués tels quels : réservez les clés limitées à l’organisation aux administrateurs)

Réponse (200) :

Modifié

{
	"message": "string"
}
Champ Type Obligatoire Description
message chaîne Oui

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 403 La clé API ne dispose pas de la portée ou de l’accès à l’organisation requis, l’environnement est inactif ou le forfait ne permet pas ce type de fichier
  • 404 Ressource introuvable

Retirer un utilisateur de l’organisation (nécessite une clé API limitée à l’organisation)

Le paramètre de chemin {tenantId&#125 ; correspond à l’environnement de contexte (l’organisation associée à la clé limitée à l’organisation), et non à la cible de l’opération.

Point de terminaison : DELETE /v1/tenant/{tenantId}/organization/users/{userId}

Authentification : Clé API limitée à l’organisation · portée write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
userId chaîne chemin Oui Format : uuid

Réponse (200) :

Utilisateur retiré

{
	"message": "string"
}
Champ Type Obligatoire Description
message chaîne Oui

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 403 La clé API ne dispose pas de la portée ou de l’accès à l’organisation requis, l’environnement est inactif ou le forfait ne permet pas ce type de fichier
  • 404 Ressource introuvable

Documentation associée

Concevez de meilleurs processus. Bâtissez une architecture cohérente. Gardez la maîtrise.

Accédez immédiatement à la plateforme, sans carte bancaire ni attente. Représentez clairement le fonctionnement de votre organisation dans des modèles de processus reliés entre eux.

Définissez l’architecture des processus, les responsabilités et les contrôles, puis clarifiez les rôles à chaque niveau.

Démarrez votre essai gratuit et posez les bases d’une gouvernance, d’une gestion et d’une amélioration continue de vos processus.

Démarrez votre essai gratuit dès aujourd’hui.