Skip to content

Obter dados do tenant

GET
/tenant

Retorna os dados completos do tenant autenticado.

Este endpoint retorna as mesmas informações de um tenant individual
que seriam retornadas no GET /tenants, porém usando o Tenant Token
ao invés do Client Token.

Uso Comum

  • Obter informações do tenant a partir do próprio token
  • Verificar recursos disponíveis (mesas, apps, tabelas)
  • Consultar variáveis de desenvolvimento

Campos Retornados

Campo Descrição
id ID interno do tenant
nome Nome do tenant
token Tenant Token (confirmação)
dominio Domínio de acesso
ativo Status ativo/inativo
development_variables Variáveis globais do ETL
config Configurações do tenant
dw_desks Mesas de Data Warehouse
bi_desks Mesas de Business Intelligence
bi_apps Aplicações DataViz
dw_tables Tabelas (resumo)
sys_users_tenants Usuários vinculados

Autorizações

tenantBearerAuth

Token de acesso do tenant

TipoHTTP (bearer)

Respostas

Dados do tenant retornados 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",
"db_user": "etl_user"
},
"config": {
"features": {
"enable_ai": true
}
},
"dw_desks": [
{
"id": 1,
"nome": "Mesa DW Principal"
}
],
"bi_desks": [
{
"id": 1,
"nome": "Mesa BI Principal"
}
],
"bi_apps": [
{
"id": 10,
"nome": "Dashboard Vendas",
"deskId": 1
},
{
"id": 11,
"nome": "Dashboard Financeiro",
"deskId": 1
}
],
"dw_tables": [
{
"id": 100,
"nome": "fat_vendas",
"deskId": 1
},
{
"id": 101,
"nome": "dim_produto",
"deskId": 1
}
],
"sys_users_tenants": [
{
"ultimo_login": "2024-12-16T10:00:00Z",
"user": {
"id": 1,
"login": "admin@empresa.com",
"nome": "Administrador"
}
}
]
}
}

Playground

Autorização

Exemplos

Desenvolvido por VitePress OpenAPI