Buscar K
Aparência
Gerar a URL de login transparente
POST
/tenant/login
Gera a URL de login transparente de um usuário do tenant: quem já entrou no seu sistema abre o Lumo sem digitar senha. O passo a passo está em Login transparente.
O token é um JWT que vale 1 hora a partir de quando foi gerado e pode ser usado mais de uma vez nesse prazo. A sessão aberta pela URL acaba junto com ele, mesmo com o usuário navegando. Gere uma URL nova cada vez que o usuário abrir o Lumo no seu sistema e, em sessão longa, recarregue o iframe com uma URL nova antes de completar 1 hora.
A sessão fica presa a este tenant e a este usuário: dentro dela não é possível trocar de tenant nem acessar como outro usuário.
A resposta vem sem o envelope status/data. O host da url é o domínio do tenant.
Se o domínio do tenant tem mais de um endereço separado por vírgula, monte a URL com
o seu domínio: https://<dominio>/auth/api/<token>?showMenu=0.
Campos
| Campo | Descrição |
|---|---|
success |
true quando a URL foi gerada |
token |
O JWT de login |
url |
URL para iframe, redirecionamento ou WebView |
Parâmetros da URL
Valem para a sessão inteira, não só para a primeira página.
| Parâmetro | Valores | Descrição |
|---|---|---|
showMenu |
0 / 1 |
0 esconde o menu principal. Padrão 1; a url já vem com 0 |
showDesksIcon |
0 / 1 |
0 esconde o ícone de Mesas. Padrão 1 |
forceTheme |
light / dark |
Força o tema claro ou escuro |
ref |
Base64 | Rota que abre depois do login, em ASCII codificado em Base64 |
Com ref, a rota /app/report/1 vira L2FwcC9yZXBvcnQvMQ==:
https://[dominio]/auth/api/[token]?showMenu=0&ref=L2FwcC9yZXBvcnQvMQ==
Os jeitos de abrir a URL e como montar um menu próprio com showMenu=0 estão em
Login transparente.
Mensagens de erro
| Status | Mensagem | Causa |
|---|---|---|
| 404 | Usuário não encontrado |
Login não existe ou não está vinculado ao tenant |
| 403 | Este usuário não pode entrar pela API do tenant. |
Usuário da equipe da plataforma |
As duas falhas trazem success: false. Até 28/10/2026 elas voltavam com HTTP 200.
Autorizações
tenantBearerAuth
Token de acesso do tenant
TipoHTTP (bearer)
Corpo da Requisição
application/json
JSON
Respostas
Operação processada
application/json
JSON