Référence API : Organisations
Référence API pour la gestion des organisations et des utilisateurs.
Récupérer les informations d’un tenant précis.
Endpoint : GET /tenant/{tenantId}
Paramètres :
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "My Company",
"createdAt": "2024-01-15T10:30:00Z",
"plan": "professional"
}
Modifier les paramètres du tenant, comme le nom d’affichage.
Endpoint : PUT /tenant/{tenantId}
Paramètres :
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Corps de requête :
{
"displayName": "New Company Name"
}
Réponse : Retourne le tenant mis à jour.
Récupérer les statistiques d’utilisation pour un tenant.
Endpoint : GET /tenant/{tenantId}/statistics
Paramètres :
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
{
"processCount": 15,
"datasetCount": 8,
"userCount": 5,
"storageUsedBytes": 1073741824
}
Récupérer tous les utilisateurs ayant accès à un tenant.
Endpoint : GET /tenant/{tenantId}/users
Paramètres :
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
[
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"email": "user@example.com",
"firstName": "John",
"lastName": "Doe",
"createdAt": "2024-01-15T10:30:00Z",
"lastLoginAt": "2024-03-01T14:00:00Z",
"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"isActiveInTenant": true,
"isAdminInTenant": false,
"isDeveloperInTenant": false,
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": false
}
]
Ajoutez un nouvel utilisateur à un tenant. L’utilisateur sera créé s’il n’existe pas ou ajouté au tenant si un compte existe déjà. L’identifiant de l’utilisateur est renvoyé dans la réponse.
Endpoint : POST /tenant/{tenantId}/users
Paramètres :
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Corps de requête :
{
"email": "newuser@example.com",
"firstName": "John",
"lastName": "Doe",
"isAdminInTenant": false,
"isActiveInTenant": true,
"isDeveloperInTenant": false
}
| Champ | Type | Requis | Description |
|---|---|---|---|
| string | Oui | Adresse email de l’utilisateur | |
| firstName | string | Non | Prénom de l’utilisateur |
| lastName | string | Non | Nom de l’utilisateur |
| isAdminInTenant | boolean | Non | L’utilisateur a-t-il les droits admin sur ce tenant |
| isActiveInTenant | boolean | Non | L’utilisateur est-il actif sur ce tenant |
| isDeveloperInTenant | boolean | Non | L’utilisateur a-t-il l’accès développeur sur ce tenant |
Réponse :
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"message": "Utilisateur ajouté au tenant."
}
Mettre à jour les permissions d’un utilisateur dans un tenant.
Endpoint : PUT /tenant/{tenantId}/users
Corps de requête :
{
"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"isAdminInTenant": true,
"isActiveInTenant": true,
"isDeveloperInTenant": false
}
| Champ | Type | Requis | Description |
|---|---|---|---|
| userId | string | Oui | Identifiant unique de l’utilisateur |
| tenantId | string | Oui | Identifiant unique du tenant |
| isAdminInTenant | boolean | Non | L’utilisateur a-t-il les droits admin |
| isActiveInTenant | boolean | Non | L’utilisateur est-il actif sur ce tenant |
| isDeveloperInTenant | boolean | Non | L’utilisateur a-t-il l’accès développeur |
Réponse :
{
"message": "Permissions utilisateur du tenant mises à jour."
}
Retirer l’accès d’un utilisateur à un tenant.
Endpoint : DELETE /tenant/{tenantId}/users
Corps de requête :
{
"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
| Champ | Type | Requis | Description |
|---|---|---|---|
| userId | string | Oui | Identifiant unique de l’utilisateur à retirer |
| tenantId | string | Oui | Identifiant unique du tenant |
Réponse :
{
"message": "Utilisateur retiré du tenant."
}