API Locataire
Opérations de gestion des locataires au niveau système pour mindzieStudio. Créez, listez, mettez à jour et supprimez des locataires sur toute la plateforme.
IMPORTANT : Tous les points de terminaison de l’API Locataire nécessitent une clé API globale. Les clés API spécifiques aux locataires ne peuvent pas accéder à ces points de terminaison.
Fonctionnalités
Gestion
Listez tous les locataires, récupérez les détails d’un locataire, créez de nouveaux locataires et mettez à jour les paramètres des locataires. Configurez les limites d’utilisateurs, les limites de cas et les propriétés du locataire.
Suppression
Supprimez définitivement des locataires avec une triple vérification pour la sécurité. Comprend les meilleures pratiques pour l’exportation des données et les flux de travail de suppression sécurisée.
Points de terminaison disponibles
| Méthode | Point de terminaison | Description |
|---|---|---|
| GET | /api/tenant |
Liste tous les locataires |
| GET | /api/tenant/{tenantId} |
Obtenir un locataire par ID |
| POST | /api/tenant |
Créer un locataire |
| PUT | /api/tenant |
Mettre à jour un locataire |
| DELETE | /api/tenant |
Supprimer un locataire |
Champs de l’objet Locataire
| Champ | Type | Description |
|---|---|---|
tenantId |
GUID | Identifiant unique du locataire |
name |
chaîne | Nom système unique (utilisé dans les URL) |
displayName |
chaîne | Nom affiché lisible |
description |
chaîne | Description du locataire |
caseCount |
entier | Nombre total de cas |
maxUserCount |
entier | Nombre maximum d’utilisateurs autorisés |
maxAnalystCount |
entier | Nombre maximum d’analystes autorisés |
userCount |
entier | Nombre actuel d’utilisateurs |
analystCount |
entier | Nombre actuel d’analystes |
isDisabled |
booléen | Si le locataire est désactivé |
isAcademic |
booléen | Si c’est un locataire académique |
preRelease |
booléen | Si le locataire a des fonctionnalités en pré-version |
dateCreated |
datetime | Date de création du locataire |
Authentification
| Point de terminaison | Type de clé API | Accès |
|---|---|---|
Tous les points /api/tenant |
Clé API globale | Requis |
| Clé API Locataire | 401 Non autorisé |
Les clés API globales peuvent être créées via l’interface d’administration à /admin/global-api-keys.
Voir Authentification pour les détails sur les types de clés API et leur utilisation.
Démarrage rapide
# Liste tous les locataires (clé API globale requise)
curl -X GET "https://your-mindzie-instance.com/api/tenant" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Obtenir un locataire spécifique
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
Notes importantes
- Clés API globales uniquement : Tous les points locataires nécessitent des clés API globales
- Limites de licence : Surveillez le nombre de locataires par rapport aux limites de licence
- Opérations destructives : La suppression des locataires est permanente et irréversible
- Triple vérification : Les suppressions demandent une correspondance exacte de l’ID, du nom et du nom affiché
- Désactiver vs Supprimer : Envisagez de désactiver les locataires pour conserver les données tout en empêchant l’accès