Saltar para o conteúdo

Renomeia a chave ou troca os IPs permitidos

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

Auth
Exige token
Quem pode:
owner
admin
Chave de API:
Não aceita chave de API
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

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.

Parâmetros

NomeOndeTipoDescrição
idobrigatóriopathstring (uuid)

Headers

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

Corpo da requisição application/json

NomeTipoDescrição
nameopcionalstringmax 80
allowedIpsopcionalstring[]

Respostas

CódigoDescrição
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

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