Buscar K
Aparência
Listar tenants
GET
/tenants
Retorna todos os tenants vinculados ao cliente autenticado.
Modelo de Autenticação
A API utiliza dois níveis de autenticação:
| Token | Escopo | Endpoints |
|---|---|---|
| Client Token | Gerenciar tenants | /tenants/* |
| Tenant Token | Gerenciar recursos do tenant | /tenant/* |
Importante: O campo
tokenretornado para cada tenant é o Tenant Token que deve ser usado para autenticar nos endpoints/tenant/*(usuários, grupos, etc).
Fluxo de Integração
1. Use seu Client Token para chamar GET /tenants
2. Receba a lista de tenants, cada um com seu 'token' individual
3. Use o 'token' do tenant desejado como Bearer para endpoints /tenant/*
Campos Retornados
| Campo | Descrição |
|---|---|
id |
ID interno do tenant |
nome |
Nome do tenant |
token |
Tenant Token para autenticar em /tenant/* |
dominio |
Domínio de acesso (ex: empresa.horusbi.com.br) |
ativo |
Se o tenant está ativo |
development_variables |
Variáveis globais do ETL |
config |
Configurações do tenant |
dw_desks, bi_desks |
Mesas de dados e BI |
bi_apps |
Aplicações DataViz |
dw_tables |
Tabelas do Data Warehouse |
sys_users_tenants |
Usuários vinculados |
Autorizações
clientBearerAuth
Token de acesso do cliente
TipoHTTP (bearer)
Respostas
Lista de tenants retornada com sucesso
application/json
JSON
{
"status": "success",
"data": [
{
"id": 1,
"nome": "Empresa ABC",
"token": "tk_abc123...",
"dominio": "abc.horusbi.com.br",
"ativo": true,
"development_variables": {
"db_host": "192.168.1.100",
"environment": "production"
},
"dw_desks": [
{
"id": 1,
"nome": "Mesa Principal"
}
],
"bi_apps": [
{
"id": 10,
"nome": "Dashboard Vendas",
"deskId": 1
}
],
"sys_users_tenants": [
{
"ultimo_login": "2024-12-16T10:00:00Z",
"user": {
"id": 1,
"login": "admin@empresa.com",
"nome": "Administrador"
}
}
]
}
]
}