Cria ou troca um segredo
PUT/api/vault/secrets/{name}
- Auth
- Requiere token
- Quién puede:
- owner
- admin
- 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.
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).
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
nameobligatorio | path | string |
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
| Nombre | Tipo | Descripción |
|---|---|---|
valueopcional | string | max 4096 |
allowedHostsopcional | string[] |
Respuestas
| Código | Descripción |
|---|---|
200 | O segredo (sem o valor). |
403 | Autenticado, mas sem permissão para esta operação. |
409 | Corrida com outro cadastro do mesmo nome (`vault.nameTaken`). |
422 | Nome, valor ou hosts inválidos, ou falta o aceite do aviso de dados. |
Ejemplo con 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 '{}'