Referência da API

Vaults

Gerencie cofres e credenciais usadas por sessions autorizadas.

#Endpoints

MétodoCaminhoDescrição
POST/v1/vaultsCria um vault.
GET/v1/vaultsLista vaults por cursor.
DELETE/v1/vaults/:idRemove um vault.
POST/v1/vaults/:id/credentialsCria credencial `portal_login` ou `oauth2`.
GET/v1/vaults/:id/credentialsLista metadados de credenciais.
DELETE/v1/vaults/:id/credentials/:credentialIdRemove uma credencial.
POST/v1/vaults/:id/credentials/:credentialId/revokeRevoga uma credencial.

#Credencial de portal

json
{
  "type": "portal_login",
  "name": "Portal seguradora",
  "boundDomain": "portal.seguradora.example",
  "username": "operador@example.com",
  "password": "..."
}

#Credencial OAuth2

json
{
  "type": "oauth2",
  "name": "CRM",
  "boundDomain": "api.crm.example",
  "accessToken": "...",
  "refreshToken": "...",
  "tokenEndpoint": "https://api.crm.example/oauth/token",
  "clientId": "...",
  "clientSecret": "...",
  "scope": "customers:read"
}

Respostas de leitura retornam metadados, não material sensível.