vértice
Produto Preços Painel
Autenticação

Autenticação

Cadastro, login, sessão, convites e autenticação em dois fatores. As rotas de escrita por sessão exigem o header CSRF.

Referência

13 endpoints

POST /auth/signup →

Criar workspace e conta proprietária

Cria um workspace isolado, a conta proprietária e a sessão inicial. O primeiro cadastro da instalação pode adotar instâncias órfãs de versões antigas.

Público · Sem autenticação
POST /auth/login →

Login por e-mail e senha

Autentica e-mail e senha. Se o 2FA estiver ativo, a resposta não cria sessão: devolve um desafio de 5 minutos para confirmar o código.

Público · Sem autenticação
POST /auth/logout →

Encerrar a sessão e limpar cookies

Encerra a sessão atual, remove o registro do banco e limpa os cookies de sessão e CSRF.

Público · Sem autenticação
GET /auth/me →

Usuário, workspace, limites e uso

Retorna o usuário autenticado, o workspace, os limites do plano, o uso atual e se o 2FA está ativo.

Sessão do painel · Sessão
POST /auth/2fa/setup →

Gerar segredo TOTP e QR code

Gera um segredo TOTP novo e devolve o QR code e a URL otpauth para configurar o app autenticador. Só funciona antes de ativar o 2FA.

Sessão do painel · Sessão + CSRF
POST /auth/2fa/enable →

Confirmar código e ativar 2FA

Confere o código do app autenticador e ativa o 2FA. Devolve oito códigos de recuperação de uso único, exibidos apenas uma vez.

Sessão do painel · Sessão + CSRF
POST /auth/2fa/verify →

Trocar desafio + código por sessão

Troca o desafio emitido pelo login por uma sessão válida. Aceita o código TOTP atual ou um código de recuperação ainda não utilizado.

Público · Sem autenticação
POST /auth/2fa/disable →

Desativar 2FA com a senha atual

Desativa o 2FA do usuário após confirmar a senha atual. O segredo e os códigos de recuperação são apagados.

Sessão do painel · Sessão + CSRF
POST /auth/2fa/recovery-codes →

Regenerar códigos de recuperação

Gera um novo conjunto de códigos de recuperação e invalida os anteriores. Exige a senha atual e o 2FA ativo.

Sessão do painel · Sessão + CSRF
PATCH /auth/profile →

Atualizar o nome do usuário

Atualiza o nome exibido do usuário autenticado.

Sessão do painel · Sessão + CSRF
POST /auth/password →

Trocar a senha e encerrar outras sessões

Troca a senha após confirmar a senha atual e encerra as outras sessões do usuário.

Sessão do painel · Sessão + CSRF
GET /invitations/:token →

Informações públicas de um convite

Retorna informações públicas de um convite válido.

Público · Sem autenticação
POST /invitations/:token/accept →

Aceitar convite e criar a conta

Aceita o convite, cria a conta com o papel definido e inicia a sessão.

Público · Sem autenticação