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

Référence API : organisations

warning

La suppression d’un tenant supprimera définitivement tous ses processus, jeux de données et affectations d’utilisateurs. Cette action est irréversible. Vous ne pouvez pas supprimer le tenant utilisé pour vous authentifier.

warning

La suppression d’un utilisateur de l’organisation révoquera son accès à tous les tenants de l’organisation.

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

Obtenir l’organisation du tenant

Lecture possible avec une clé API limitée au tenant ; une clé limitée à l’organisation est également acceptée.

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

Authentification : Clé API limitée au tenant 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 Par défaut : ""
Longueur maximale : 128
createdAt string Oui Format : date-time
contactEmail string Oui Format : email
isActive boolean Oui Par défaut : true
allowedLogins object Oui
createdBy string Oui Format : uuid

Erreurs :

  • 401 Clé API absente, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Obtenir la capacité en 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 sièges de lecture gratuits, la cible de synchronisation automatique, l’explication de l’écart de licences utilisateur (ce que le moteur fera et à quel moment), l’intervalle de facturation et externalApiSeatPolicy. Lecture possible avec une clé API limitée au tenant. Le paramètre de chemin {tenantId&#125 ; correspond au tenant de contexte (l’organisation de 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 au tenant ou à l’organisation · portée read

Paramètres :

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

Réponse (200) :

Capacité en licences utilisateur

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 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
totalBillable number Oui
freeViewerAllowance number Oui
freeViewerOverAllowance 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 absente, non valide, désactivée ou expirée
  • 404 Ressource introuvable

Obtenir les statistiques à l’échelle de l’organisation

Le paramètre de chemin {tenantId&#125 ; correspond au tenant de contexte (l’organisation de 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 absente, non valide, désactivée ou expirée

Répertorier tous les tenants de l’organisation

Le paramètre de chemin {tenantId&#125 ; correspond au tenant de contexte (l’organisation de 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 tenants

[
	{
		"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
		},
		"url": "string"
	}
]

Erreurs :

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

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

Le paramètre de chemin {tenantId&#125 ; correspond au tenant de contexte (l’organisation de 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 string chemin Oui Format : uuid

Corps de la requête :

{
	"displayName": "string",
	"shortName": "string",
	"description": "string"
}
Champ Type Obligatoire Description
displayName string Non Longueur maximale : 128
shortName string Oui
description string Non Longueur maximale : 200

Réponse (201) :

Tenant 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
	},
	"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 Par défaut : ""
Longueur maximale : 128
contactEmail string Oui Format : email
isActive boolean Oui Par défaut : true
shortName string Oui
useOrganizationTheme boolean Oui Par défaut : true
description string Oui Longueur maximale : 200
organizationId string Oui Format : uuid
allowedLogins object Oui
url string Oui Format : uri

Erreurs :

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

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

L’accès API du tenant est immédiatement interrompu. Le tenant et ses données sont conservés pendant la période de sécurité suivant la suppression, puis supprimés par l’opération automatisée de suppression définitive. Le tenant que vous utilisez actuellement (le tenant 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 string chemin Oui Format : uuid
targetId string chemin Oui Format : uuid

Réponse (200) :

Tenant supprimé

{
	"success": true,
	"message": "string"
}
Champ Type Obligatoire Description
success boolean Oui
message string Oui

Erreurs :

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

Restaurer un tenant 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é suivant la suppression : le tenant et ses données sont restaurés à l’identique et l’accès API reprend. Le paramètre de chemin {tenantId&#125 ; correspond au tenant de contexte (l’organisation de 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 string chemin Oui Format : uuid
targetId string chemin Oui Format : uuid

Réponse (200) :

Tenant restauré

{
	"success": true,
	"message": "string"
}
Champ Type Obligatoire Description
success boolean Oui
message string Oui

Erreurs :

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

Répertorier tous les utilisateurs de l’organisation

Le paramètre de chemin {tenantId&#125 ; correspond au tenant de contexte (l’organisation de 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 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 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 absente, non valide, désactivée ou expirée

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

Les indicateurs de rôle du corps de la requête (isAdminInOrganization, isActiveInOrganization) sont appliqués tels quels ; attribuez les clés limitées à l’organisation uniquement aux administrateurs de l’organisation. Le paramètre de chemin {tenantId&#125 ; correspond au tenant de contexte (l’organisation de 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 string chemin Oui Format : uuid
userId string chemin Oui Format : uuid

Corps de la requête :

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

Réponse (200) :

Mis à jour

{
	"message": "string"
}
Champ Type Obligatoire Description
message string Oui

Erreurs :

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

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

Le paramètre de chemin {tenantId&#125 ; correspond au tenant de contexte (l’organisation de 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 string chemin Oui Format : uuid
userId string chemin Oui Format : uuid

Réponse (200) :

Utilisateur supprimé

{
	"message": "string"
}
Champ Type Obligatoire Description
message string Oui

Erreurs :

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

Documentation associée