Aller au contenu

Renomeia a chave ou troca os IPs permitidos

PATCH/api/integrations/api-keys/{id}

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
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.

Só o dono da chave (outra pessoa, mesmo owner ou admin, recebe 403). Os escopos não se editam. A lista de IPs nova vale na chamada seguinte; cada mudança vai para Membros › Logs. Chave revogada dá 409.

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

NomTypeDescription
namefacultatifstringmax 80
allowedIpsfacultatifstring[]

Réponses

StatutDescription
200A chave atualizada.
400Requisição inválida — falha de validação.
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.
409Conflito com o estado atual do recurso.
422Nome ou IP inválido

Exemple curl

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