Zum Inhalt springen

Renomeia a chave ou troca os IPs permitidos

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

Auth
Token erforderlich
Wer darf:
owner
admin
API-Schlüssel:
Kein API-Schlüssel möglich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring (uuid)

Header

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

Request-Body application/json

NameTypBeschreibung
nameoptionalstringmax 80
allowedIpsoptionalstring[]

Antworten

StatusBeschreibung
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

curl-Beispiel

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 '{}'