Cycle de vie d'un tenant
Les endpoints d’administration gèrent le cycle de vie d’un tenant. Ils
sont identiques entre l’Auth Relay et le Chat Relay, à quelques différences
près signalées plus bas. Tous sont protégés par l’en-tête X-Admin-Key
(une clé d’opérateur, distincte des secrets de tenant).
Convention de paramètres
Section intitulée « Convention de paramètres »Une règle simple, valable partout :
provisionprend un corps JSON. C’est la seule création ; elle reçoit toute la configuration du tenant dans le corps.- Tout le reste prend
?tenant_id=en paramètre de requête (update,rotate/*,suspend,reactivate,fetch).updateaccepte en plus un corps partiel.
Endpoints (forme commune)
Section intitulée « Endpoints (forme commune) »| Méthode | Chemin | Paramètres | Effet |
|---|---|---|---|
POST | /provision/tenant | corps JSON | Crée le tenant ; renvoie tenant_id + tenant_secret une seule fois. |
POST | /update/tenant | ?tenant_id= + corps | Mise à jour partielle de la configuration. |
POST | /rotate/tenant-secret | ?tenant_id= | Nouveau tenant_secret ; l’ancien est invalidé immédiatement. |
POST | /suspend/tenant | ?tenant_id= | Bloque les appels signés (403) jusqu’à réactivation. |
POST | /reactivate/tenant | ?tenant_id= | Lève la suspension. |
GET | /fetch/tenant | ?tenant_id= | Renvoie la configuration (jamais le secret). |
GET | /fetch/tenants | ?limit=&offset= | Liste paginée. |
Différences par relais :
- Chat Relay ajoute
POST /rotate/widget-key?tenant_id=et renvoie unwidget_public_keyau provisioning. Voir Gestion des tenants — Chat Relay. - La forme exacte des corps (champs de branding, quotas, options) est propre à chaque relais : voir Gestion des tenants — Auth Relay et Gestion des tenants — Chat Relay.
Faire tourner un secret compromis
Section intitulée « Faire tourner un secret compromis »- Appelez
POST /rotate/tenant-secret?tenant_id=...avecX-Admin-Key. - Récupérez le nouveau
tenant_secretdans la réponse (affiché une fois). - Déployez-le dans le coffre à secrets de votre backend.
- L’ancien secret cesse de signer valablement immédiatement : prévoyez un court basculement.
Suspendre vs supprimer
Section intitulée « Suspendre vs supprimer »La suspension est réversible et bloque immédiatement tous les appels
signés du tenant (réponse 403). C’est le levier à utiliser en cas
d’incident : suspend maintenant, enquêter, puis reactivate.
Étapes suivantes
Section intitulée « Étapes suivantes »- Authentification (HMAC) — utiliser les secrets obtenus ici.
- Multi-tenant & relay_user_id — le modèle de locataires.