Réponse exemple
/v1/rooms/{id}/members?id={memberId}Révoque l'accès d'un membre identifié à une salle de partage.Révoque l'accès d'un membre à une salle de partage. Le membre, désigné par le paramètre de requête id, n'est pas supprimé : son champ revoked_at est renseigné avec l'horodatage courant, ce qui invalide son lien magique tout en conservant la trace de l'invitation. L'endpoint vérifie d'abord que la salle appartient à l'espace de travail du jeton (sinon 404), puis applique la révocation en ciblant à la fois l'id du membre et l'id de la salle.
Authentification
Requiert une clé API valide disposant du scope rooms:manage (ou d'un scope englobant comme rooms:* ou *). À défaut, l'appel renvoie un 403 scope_missing.
Paramètres de requête
| Champ | Type | Requis | Description |
|---|---|---|---|
| id (chemin) | string | Oui | Identifiant de la salle, dans le chemin de l'URL. |
| id (query) | string | Oui | Identifiant du membre à révoquer, passé en paramètre de requête ?id=…. Son absence renvoie un 400. |
Réponse
En cas de succès, la réponse a un statut 200 et contient { "ok": true }. L'opération est idempotente sur le plan métier : révoquer un membre déjà révoqué réinscrit simplement l'horodatage et renvoie le même résultat.
Erreurs
| Code | Quand | Résolution |
|---|---|---|
| 400 validation_error | Paramètre de requête id (membre) absent. | Ajoutez ?id=<member_id> à l'URL. |
| 401 invalid_api_key | Clé API absente, malformée ou non reconnue. | Vérifiez l'en-tête Authorization. |
| 403 scope_missing | Le jeton ne porte pas le scope rooms:manage. | Utilisez une clé incluant rooms:manage. |
| 404 not_found | Aucune salle avec cet id dans l'espace de travail du jeton. | Vérifiez l'id de la salle et l'espace de travail de la clé. |
| 429 rate_limited | Quota de requêtes en écriture par minute dépassé. | Respectez l'en-tête Retry-After. |
| 500 internal_error | Échec de la mise à jour en base. | Réessayez ; conservez le X-Request-Id pour le support. |
Voir aussi
- GET /v1/rooms/{id}/members pour récupérer l'
iddu membre à révoquer. - POST /v1/rooms/{id}/members pour réinviter un membre (réactive un membre révoqué).
- GET /v1/rooms/{id} pour les métadonnées de la salle.