Liste des documents
Sur cette page

Référence API : Tenants

Endpoints Tenant

Obtenir un Tenant

Récupérer les informations d’un tenant précis.

Endpoint : GET /tenant/{tenantId}

Paramètres :

NomTypeEmplacementRequisDescription
tenantIdstringpathOuiIdentifiant unique du tenant

Réponse :

{
	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"displayName": "My Company",
	"createdAt": "2024-01-15T10:30:00Z",
	"plan": "professional"
}

Mettre à jour le tenant

Modifier les paramètres du tenant, comme le nom d’affichage.

Endpoint : PUT /tenant/{tenantId}

Paramètres :

NomTypeEmplacementRequisDescription
tenantIdstringpathOuiIdentifiant unique du tenant

Corps de requête :

{
	"displayName": "New Company Name"
}

Réponse : Retourne le tenant mis à jour.


Obtenir les statistiques du tenant

Récupérer les statistiques d’utilisation pour un tenant.

Endpoint : GET /tenant/{tenantId}/statistics

Paramètres :

NomTypeEmplacementRequisDescription
tenantIdstringpathOuiIdentifiant unique du tenant

Réponse :

{
	"processCount": 15,
	"datasetCount": 8,
	"userCount": 5,
	"storageUsedBytes": 1073741824
}

Endpoints Utilisateurs du Tenant

Lister les utilisateurs du tenant

Récupérer tous les utilisateurs ayant accès à un tenant.

Endpoint : GET /tenant/{tenantId}/users

Paramètres :

NomTypeEmplacementRequisDescription
tenantIdstringpathOuiIdentifiant 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
	}
]

Ajouter un utilisateur au Tenant

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 :

NomTypeEmplacementRequisDescription
tenantIdstringpathOuiIdentifiant unique du tenant

Corps de requête :

{
	"email": "newuser@example.com",
	"firstName": "John",
	"lastName": "Doe",
	"isAdminInTenant": false,
	"isActiveInTenant": true,
	"isDeveloperInTenant": false
}
ChampTypeRequisDescription
emailstringOuiAdresse email de l’utilisateur
firstNamestringNonPrénom de l’utilisateur
lastNamestringNonNom de l’utilisateur
isAdminInTenantbooleanNonL’utilisateur a-t-il les droits admin sur ce tenant
isActiveInTenantbooleanNonL’utilisateur est-il actif sur ce tenant
isDeveloperInTenantbooleanNonL’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 un utilisateur du 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
}
ChampTypeRequisDescription
userIdstringOuiIdentifiant unique de l’utilisateur
tenantIdstringOuiIdentifiant unique du tenant
isAdminInTenantbooleanNonL’utilisateur a-t-il les droits admin
isActiveInTenantbooleanNonL’utilisateur est-il actif sur ce tenant
isDeveloperInTenantbooleanNonL’utilisateur a-t-il l’accès développeur

Réponse :

{
	"message": "Permissions utilisateur du tenant mises à jour."
}

Retirer un utilisateur du tenant

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"
}
ChampTypeRequisDescription
userIdstringOuiIdentifiant unique de l’utilisateur à retirer
tenantIdstringOuiIdentifiant unique du tenant

Réponse :

{
	"message": "Utilisateur retiré du tenant."
}