Aller au contenu
memberfy
FR

Cria ou troca um segredo

PUT/api/vault/secrets/{name}

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ó owner e admin. `name` em maiúsculas (`[A-Z][A-Z0-9_]{0,63}`). `value` (até 4.096) entra uma vez e **não volta**; mandar de novo troca na hora. `allowedHosts` (até 20) limita para onde o segredo pode ir (vazio: qualquer host que o nó HTTP aceita); sem `value`, só troca os hosts de um segredo que já existe. Antes do primeiro segredo, alguém da equipe aceita o aviso de dados pessoais (`POST /api/vault/data-notice`), senão 422 `vault.dataNoticeRequired`. Criar, trocar e mudar hosts entram na auditoria (só o nome e os 4 últimos).

Paramètres

NomEmplacementTypeDescription
nameobligatoirepathstring

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
valuefacultatifstringmax 4096
allowedHostsfacultatifstring[]

Réponses

StatutDescription
200O segredo (sem o valor).
403Autenticado, mas sem permissão para esta operação.
409Corrida com outro cadastro do mesmo nome (`vault.nameTaken`).
422Nome, valor ou hosts inválidos, ou falta o aceite do aviso de dados.

Exemple curl

curl -X PUT "https://api.memberfy.net/api/vault/secrets/<name>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'