Revoga uma chave de API
POST/api/integrations/api-keys/{id}/revoke
- Auth
- Requiere token
- Clave de API:
- No acepta clave de API
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
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á.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
idobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
La especificación no declara los campos de este cuerpo (una subida multipart, por ejemplo). Consulta la guía del tema.
Respuestas
| Código | Descripción |
|---|---|
200 | A chave revogada. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
Ejemplo con 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 '{}'