Référence API : Tenants
Référence API pour gérer les tenants et contrôler l'accès utilisateur.
Sur cette page
Référence API : Organisations
Points d’accès Organisation
Les organizations regroupent plusieurs tenants sous une seule entité.
Obtenir l’Organisation
Récupérez les informations de l’organisation à laquelle un tenant appartient.
Endpoint : GET /tenant/{tenantId}/organization
Paramètres :
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
{
"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"displayName": "Acme Corporation",
"createdAt": "2023-06-01T00:00:00Z"
}
Obtenir les Statistiques d’Organisation
Obtenez les statistiques globales de l’organisation.
Endpoint : GET /tenant/{tenantId}/organization/statistics
Paramètres :
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
{
"tenantCount": 5,
"totalProcessCount": 42,
"totalDatasetCount": 18,
"totalUserCount": 25,
"totalStorageUsedBytes": 5368709120
}
Lister les Tenants de l’Organisation
Récupérez tous les tenants de l’organisation.
Endpoint : GET /tenant/{tenantId}/organization/tenants
Paramètres :
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
[
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "Sales Department",
"createdAt": "2024-01-01T00:00:00Z"
},
{
"id": "d4e5f6a7-b8c9-0123-def4-567890123456",
"displayName": "Operations",
"createdAt": "2024-02-15T00:00:00Z"
}
]
Créer un Tenant
Créez un nouveau tenant dans l’organisation.
Endpoint : POST /tenant/{tenantId}/organization/tenants
Paramètres :
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique d’un tenant existant dans l’organisation |
Corps de la requête :
{
"shortName": "sales-team",
"displayName": "Sales Team",
"description": "Tenant pour l’équipe commerciale"
}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| shortName | string | Oui | Identifiant URL-friendly (minuscules et tirets autorisés) |
| displayName | string | Non | Nom affiché pour le tenant |
| description | string | Non | Description du tenant |
Réponse : Retourne l’objet tenant créé.
Supprimer un Tenant
Supprimez un tenant de l’organisation.
Endpoint : DELETE /tenant/{tenantId}/organization/tenants/{targetTenantId}
Paramètres :
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique d’un tenant existant dans l’organisation |
| targetTenantId | string | path | Oui | Identifiant unique du tenant à supprimer |
Réponse :
{
"success": true
}
warning
Supprimer un tenant supprimera définitivement tous ses process, jeux de data et affectations utilisateurs. Cette action est irréversible. Il est impossible de supprimer le tenant utilisé pour l’authentification.
Points d’accès Utilisateurs d’Organisation
Lister les Utilisateurs de l’Organisation
Récupérez tous les utilisateurs de l’organisation.
Endpoint : GET /tenant/{tenantId}/organization/users
Paramètres :
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
[
{
"id": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"email": "admin@example.com",
"firstName": "Jane",
"lastName": "Smith",
"createdAt": "2023-06-01T00:00:00Z",
"lastLoginAt": "2024-03-01T10:00:00Z",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
]
Mettre à jour un Utilisateur de l’Organisation
Modifiez les permissions d’un utilisateur dans l’organisation.
Endpoint : PUT /tenant/{tenantId}/organization/users
Corps de la requête :
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| userId | string | Oui | Identifiant unique de l’utilisateur |
| organizationId | string | Oui | Identifiant unique de l’organisation |
| isActiveInOrganization | boolean | Non | Indique si l’utilisateur est actif |
| isAdminInOrganization | boolean | Non | Indique si l’utilisateur a les droits admin dans l’organisation |
Réponse :
{
"message": "Paramètres utilisateur organisation mis à jour."
}
Retirer un Utilisateur de l’Organisation
Retirez complètement un utilisateur de l’organisation.
Endpoint : DELETE /tenant/{tenantId}/organization/users
Corps de la requête :
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234"
}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| userId | string | Oui | Identifiant unique de l’utilisateur à retirer |
| organizationId | string | Oui | Identifiant unique de l’organisation |
Réponse :
{
"message": "Utilisateur supprimé de l’organisation."
}
warning
Retirer un utilisateur de l’organisation révoquera son accès à tous les tenants de cette organisation.