Référence APIRévoquer un invité d'un coffre
DELETE/v1/coffres/{id}/guests

Révoquer un invité d'un coffre

Passe un invité au statut révoqué pour lui retirer l'accès au coffre.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"revoked": true
}
DELETE/v1/coffres/{id}/guestsRévoque un invité d'un coffre (statut passé à revoked).

Révoque l'accès d'un invité à un coffre. La révocation est une suppression logique : le statut de l'invité passe à revoked plutôt que de supprimer la ligne, ce qui le retire des listes renvoyées par GET. L'opération vérifie au préalable que le coffre appartient au workspace de la clé. Note : ce handler ne lit pas de corps JSON au sens du wrapper (les requêtes DELETE n'ont pas leur corps parsé automatiquement), mais il attend néanmoins un champ guest_id.

Authentification

Requiert une clé API valide portant le scope coffres:manage. Un token avec coffres:* ou * satisfait également l'exigence via la table d'alias.

Corps de la requête

ChampTypeRequisDescription
guest_idstringOuiIdentifiant de l'invité à révoquer. L'invité doit être rattaché au coffre {id}.

Réponse

En cas de succès, renvoie { "revoked": true }. La mise à jour cible l'invité par id et coffre_id ; si l'id ne correspond à aucun invité du coffre, l'opération réussit malgré tout (aucune ligne affectée) et renvoie revoked: true.

Erreurs

CodeQuandRésolution
400 validation_errorguest_id manquant ou non-string.Fournir un guest_id valide.
401 invalid_api_keyClé absente, mal préfixée ou introuvable.Vérifier l'en-tête Authorization.
403 scope_missingLa clé ne porte pas coffres:manage.Émettre une clé avec le bon scope.
404 not_foundLe coffre n'existe pas dans le workspace.Vérifier {id} et le workspace de la clé.
429 rate_limitedQuota par minute dépassé.Respecter Retry-After puis réessayer.
500 internal_errorÉchec de la mise à jour en base.Réessayer ; contacter le support avec le request_id.

Voir aussi