Skip to main content
Esta página é voltada a fluxos operacionais de suporte. O acesso exige chave de API configurada e User-Agent permitido.

​
Autenticação

Requisições para a User Management API exigem:
  • header X-API-Key com a chave operacional configurada
  • header User-Agent com um identificador permitido
O valor g4-engineering é aceito como fallback quando configurado no ambiente operacional.

​
Enviar código de login

POST /api/users/:email/send-login-code
Dispara o mesmo fluxo de OTP por email usado pela tela de login gerenciado do desktop. Comportamento esperado:
  • cria o usuário quando necessário, seguindo o onboarding gerenciado
  • retorna sent: true quando o provedor aceita a entrega
  • preserva erros estruturados para diferenciar rate limit, endereço não autorizado e signup desabilitado
Exemplo de resposta: 
{
  "ok": true,
  "email": "[email protected]",
  "sent": true
}

​
Memberships de usuário

GET /api/users/:identifier/memberships
Lista empresas de Company Context vinculadas a um usuário. :identifier pode ser email ou id de usuário Supabase. Quando a consulta usa id Supabase, a resolução depende do mapa de identidade persistido. Se ainda não houver registro de identidade, o endpoint pode retornar 404.

​
Parâmetros de query

ParâmetroPadrãoDescrição
includeDomainMatchestrueInclui empresas ativas cujo domínio permite auto-join para o email do usuário, mesmo sem materializar membro.
includeRemovedtrueInclui registros explícitos removidos para diferenciar acesso removido de ausência de vínculo.

​
Resposta

A resposta traz o usuário resolvido, lista de memberships, filtros aplicados e metadados da resolução. Campos importantes em cada membership:
  • company: id, slug, nome e status da empresa
  • status: estado do vínculo
  • type: tipo de associação
  • membershipSource: origem do vínculo, como explícita ou domínio
  • materialized: indica se há registro materializado de membro
  • isCompanyAdmin: indica se o usuário é admin da empresa
  • grants: permissões ou nós de contexto associados
Use esse endpoint para suporte, auditoria operacional e diagnóstico de acesso ao Company Context.

​
Veja também