Référence de l’API : environnements

Consulter les informations d’un environnement

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

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

Paramètres :

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

Réponse (200) :

Détails de l’environnement

{
	"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 :

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

Modifier les paramètres de l’environnement

Point de terminaison : PUT /v1/tenant/{tenantId}

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

Paramètres :

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

Corps de la requête :

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}

Champ	Type	Obligatoire	Description
id	string	Non	Format : uuid
displayName	string	Non
contactEmail	string	Non
shortName	string	Non
description	string	Non

Réponse (200) :

Environnement modifié

{
	"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 : expression de filtre invalide, processus sans modèle, format d’import non pris en charge ou champ obligatoire manquant, par exemple
• 401 Clé API absente, invalide, 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 prend pas en charge le type de fichier
• 406 La valeur ne peut pas être acceptée (nom abrégé réservé ou déjà utilisé, par exemple)

Obtenir les statistiques de l’environnement (volume de données, modèles, simulations, utilisateurs)

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

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

Paramètres :

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

Réponse (200) :

Statistiques de l’environnement

{
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"uploadedDataSize": 0,
	"uploadedDataCount": 0,
	"modelCount": 0,
	"simulationCount": 0,
	"userCount": 0
}

Champ	Type	Obligatoire	Description
tenantId	chaîne	Oui	Format : uuid
uploadedDataSize	nombre	Oui
uploadedDataCount	nombre	Oui
modelCount	nombre	Oui
simulationCount	nombre	Oui
userCount	nombre	Oui

Erreurs :

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

Lister les utilisateurs de l’environnement

Renvoie les utilisateurs correspondants sous la forme d’un tableau JSON simple, sans nombre total. Utilisez limit/offset pour parcourir les pages.

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

Authentification : Clé API limitée à l’environnement · 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

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

Erreurs :

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

Ajouter un utilisateur à l’environnement (aucun e-mail d’invitation n’est envoyé)

Les champs de rôle du corps de la requête (isAdminInTenant, access : none|portalViewer|designer|architect|intelligence, isDashboardViewer) sont appliqués tels quels. Ce point de terminaison donne accès à toutes les fonctions d’administration de l’environnement : ne fournissez donc des clés avec portée d’écriture qu’à des appelants de confiance. L’accès en lecture seule aux Dashboards est défini par le booléen isDashboardViewer ; l’ancien rôle de lecteur en lecture seule a été supprimé.

Point de terminaison : POST /v1/tenant/{tenantId}/users

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

Paramètres :

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

Corps de la requête :

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}

Champ	Type	Obligatoire	Description
email	chaîne	Oui	Adresse e-mail de l’utilisateur (également utilisée pour la connexion) Format : email
firstName	chaîne	Non	Prénom facultatif Longueur maximale : 64
lastName	chaîne	Non	Nom facultatif Longueur maximale : 64
isActiveInTenant	booléen	Non	Indique si l’utilisateur est actif dans cet environnement
isAdminInTenant	booléen	Non	Droits d’administration dans cet environnement (appliqués tels quels : accès à toutes les fonctions d’administration de l’environnement)
access	none | portalViewer | designer | architect | intelligence	Non	Licence utilisateur à sélection unique : none | portalViewer | designer | architect | intelligence Valeurs autorisées : none, portalViewer, designer, architect, intelligence
isDashboardViewer	booléen	Non	Indique si l’utilisateur dispose d’un accès en lecture seule aux Dashboards
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr	Non	Langue préférée de l’interface pour l’utilisateur Valeurs autorisées : en, zh, es, fr, de, pt, it, nl, ja, tr

Réponse (201) :

Utilisateur ajouté

{
	"id": "string",
	"message": "string"
}

Champ	Type	Obligatoire	Description
id	chaîne	Oui	Identifiant du nouvel utilisateur
message	chaîne	Oui

Erreurs :

• 401 Clé API absente, invalide, désactivée ou expirée
• 409 La requête entre en conflit avec l’état actuel (licence utilisateur indisponible ou identifiant déjà utilisé, par exemple)

Modifier les paramètres d’un utilisateur dans l’environnement

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

Authentification : Clé API limitée à l’environnement · 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 :

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}

Champ	Type	Obligatoire	Description
isActiveInTenant	booléen	Non	Indique si l’utilisateur est actif dans cet environnement
isAdminInTenant	booléen	Non	Droits d’administration dans cet environnement (appliqués tels quels : accès à toutes les fonctions d’administration de l’environnement)
access	none | portalViewer | designer | architect | intelligence	Non	Licence utilisateur à sélection unique : none | portalViewer | designer | architect | intelligence. L’accès en lecture seule aux Dashboards est défini par le booléen isDashboardViewer. Valeurs autorisées : none, portalViewer, designer, architect, intelligence
isDashboardViewer	booléen	Non	Indique si l’utilisateur dispose d’un accès en lecture seule aux Dashboards

Réponse (200) :

Modifié

{
	"message": "string"
}

Champ	Type	Obligatoire	Description
message	chaîne	Oui

Erreurs :

• 400 Requête incorrecte : expression de filtre invalide, processus sans modèle, format d’import non pris en charge ou champ obligatoire manquant, par exemple
• 401 Clé API absente, invalide, désactivée ou expirée
• 404 Ressource introuvable

Supprimer un utilisateur de l’environnement

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

Authentification : Clé API limitée à l’environnement · 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 supprimé

{
	"message": "string"
}

Champ	Type	Obligatoire	Description
message	chaîne	Oui

Erreurs :

• 400 Requête incorrecte : expression de filtre invalide, processus sans modèle, format d’import non pris en charge ou champ obligatoire manquant, par exemple
• 401 Clé API absente, invalide, désactivée ou expirée
• 404 Ressource introuvable

Générer un jeton de transfert de connexion à usage unique pour un utilisateur

Renvoie un jeton à usage unique (durée de validité de 60 s), associé à l’utilisateur, à l’environnement et à l’organisation, ainsi que l’url vers laquelle rediriger le navigateur de l’utilisateur. Ouvrez cette URL dans son navigateur : il accède alors à ProcessMind avec une session déjà authentifiée. Aucun lien envoyé par e-mail ni usurpation d’identité ; l’utilisateur dispose de sa propre session. Une portée dédiée sessions est requise pour la clé API : une clé limitée à l’organisation peut générer un jeton pour n’importe quel environnement de cette organisation, tandis qu’une clé limitée à l’environnement ne peut le faire que pour les utilisateurs de son propre environnement. Traitez ce jeton comme un mot de passe : il n’est renvoyé qu’une seule fois, n’est jamais consigné et est révoqué si la clé ou l’utilisateur est désactivé.

Point de terminaison : POST /v1/tenant/{tenantId}/users/{userId}/login-token

Authentification : Clé API limitée à l’environnement ou à l’organisation · portée sessions · limite de débit : 2 req/s (rafale de 4)

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 :

Chemin d’accès facultatif après connexion (chemin relatif dans l’application, par exemple « app » ou « app/dashboards »)

{
	"path": "string"
}

Champ	Type	Obligatoire	Description
path	chaîne	Non	Longueur maximale : 512

Réponse (200) :

Jeton de transfert de connexion

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Champ	Type	Obligatoire	Description
token	chaîne	Oui
url	chaîne	Oui
expiresInSeconds	nombre	Oui
expiresAt	chaîne	Oui	Format : date-time

Erreurs :

• 400 Requête incorrecte : expression de filtre invalide, processus sans modèle, format d’import non pris en charge ou champ obligatoire manquant, par exemple
• 401 Clé API absente, invalide, 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 prend pas en charge le type de fichier
• 404 Ressource introuvable
• 429 Limite de débit atteinte : consultez la limite indiquée pour ce point de terminaison

Les clés API authentifient vos intégrations. Les clés limitées à une organisation peuvent créer et gérer les clés de tous les environnements de cette organisation.

Lister les clés API de l’environnement

Une clé API limitée à l’organisation est requise. Le secret n’est jamais renvoyé.

Point de terminaison : GET /v1/tenant/{tenantId}/api-keys

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 clés API

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"partialKey": "string",
		"enabled": true,
		"createdAt": "2024-03-15T16:30:00Z",
		"lastUsedAt": "2024-03-15T16:30:00Z",
		"expiresAt": "2024-03-15T16:30:00Z",
		"scope": {
			"read": true,
			"write": true,
			"uploadData": true,
			"sessions": true
		}
	}
]

Erreurs :

• 401 Clé API absente, invalide, 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 prend pas en charge le type de fichier

Créer une clé API limitée à l’environnement

Une clé d’écriture limitée à l’organisation est requise. Le secret est généré côté serveur et renvoyé une seule fois dans la réponse : conservez-le en lieu sûr. Seul son hachage est stocké.

Point de terminaison : POST /v1/tenant/{tenantId}/api-keys

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",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Champ	Type	Obligatoire	Description
displayName	chaîne	Oui	Longueur maximale : 128
scope	objet	Non
enabled	booléen	Non
expiresAt	chaîne	Non	Format : date-time

Réponse (201) :

Clé API créée (le secret à usage unique est inclus)

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"secret": "string"
}

Champ	Type	Obligatoire	Description
id	chaîne	Oui	Format : uuid
tenantId	chaîne	Oui	Format : uuid
organizationId	chaîne	Oui	Format : uuid
displayName	chaîne	Oui	Longueur maximale : 128
partialKey	chaîne	Oui	Longueur maximale : 128
enabled	booléen	Oui	Valeur par défaut : true
createdAt	chaîne	Oui	Format : date-time
lastUsedAt	chaîne	Oui	Format : date-time
expiresAt	chaîne	Oui	Format : date-time
scope	objet	Oui
secret	chaîne	Oui	Longueur maximale : 128

Erreurs :

• 400 Requête incorrecte : expression de filtre invalide, processus sans modèle, format d’import non pris en charge ou champ obligatoire manquant, par exemple
• 401 Clé API absente, invalide, 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 prend pas en charge le type de fichier

Modifier une clé API limitée à l’environnement

Une clé d’écriture limitée à l’organisation est requise. Les champs de portée sont fusionnés avec la portée enregistrée.

Point de terminaison : PUT /v1/tenant/{tenantId}/api-keys/{keyId}

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

Paramètres :

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

Corps de la requête :

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Champ	Type	Obligatoire	Description
displayName	chaîne	Non	Longueur maximale : 128
scope	objet	Non
enabled	booléen	Non
expiresAt	chaîne	Non	Format : date-time

Réponse (200) :

Clé API modifiée

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	}
}

Champ	Type	Obligatoire	Description
id	chaîne	Oui	Format : uuid
tenantId	chaîne	Oui	Format : uuid
organizationId	chaîne	Oui	Format : uuid
displayName	chaîne	Oui	Longueur maximale : 128
partialKey	chaîne	Oui	Longueur maximale : 128
enabled	booléen	Oui	Valeur par défaut : true
createdAt	chaîne	Oui	Format : date-time
lastUsedAt	chaîne	Oui	Format : date-time
expiresAt	chaîne	Oui	Format : date-time
scope	objet	Oui

Erreurs :

• 400 Requête incorrecte : expression de filtre invalide, processus sans modèle, format d’import non pris en charge ou champ obligatoire manquant, par exemple
• 401 Clé API absente, invalide, 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 prend pas en charge le type de fichier
• 404 Ressource introuvable

Supprimer une clé API limitée à l’environnement

Une clé d’écriture limitée à l’organisation est requise. La clé est supprimée de manière logique et cesse immédiatement d’authentifier les requêtes.

Point de terminaison : DELETE /v1/tenant/{tenantId}/api-keys/{keyId}

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

Paramètres :

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

Réponse (200) :

Clé API supprimée

{
	"message": "string"
}

Champ	Type	Obligatoire	Description
message	chaîne	Oui

Erreurs :

• 401 Clé API absente, invalide, 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 prend pas en charge le type de fichier
• 404 Ressource introuvable