Os segredos da comunidade (só nome e máscara)
GET/api/vault
- Auth
- Exige token
- Quem pode:
- owner
- admin
- moderator
- finance
- Chave de API:
- Não aceita chave de API
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Só owner e admin (moderador, financeiro e membro: 403). Os segredos ("Env") que nós de HTTP usam como `{{env.NOME}}` em cabeçalho e corpo. **O valor nunca volta**: só `masked` (`••••1234`) e `last4`, os hosts permitidos e quando foi usado pela última vez. Traz também o estado do aviso de dados pessoais (`dataNotice`) e por onde saem as chamadas HTTP dos workflows (`outbound`): `fixedIp` (o plano sai pelos IPs fixos: Business e Scale), `ips` (os IPs para liberar no firewall do destino; vazio sem IP fixo), `monthlyCap` (teto mensal de chamadas por IP fixo, ou `unlimited`), `usedThisMonth` e `month` (`AAAA-MM`, mês do calendário no fuso da comunidade, como toda cota do plano) e `resetsAt` (quando a contagem recomeça: meia-noite do dia 1º seguinte, nesse fuso, em UTC). Não acumula ao longo de um plano anual.
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respostas
| Código | Descrição |
|---|---|
200 | Os segredos. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
Exemplo com curl
curl -X GET "https://api.memberfy.net/api/vault" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"