Aller au contenu

Revoga uma chave de API

POST/api/integrations/api-keys/{id}/revoke

Auth
Jeton requis
Clé d’API:
Clé d’API non acceptée
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

O dono revoga a própria chave; owner e admin revogam qualquer chave da comunidade (moderador, financeiro e membro recebem 403 na chave de outra pessoa; vai para Membros › Logs com quem revogou). Vale na próxima chamada (401). Revogar de novo devolve a chave como está.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

La spécification ne déclare pas les champs de ce corps (un envoi multipart, par exemple). Consultez le guide du thème.

Réponses

StatutDescription
200A chave revogada.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.

Exemple curl

curl -X POST "https://api.memberfy.net/api/integrations/api-keys/<id>/revoke" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'