Buscar K
Aparência
Listar Tenants
GET
/tenants
Lista os Tenants do Cliente do token.
Com ?external_id=, retorna só o tenant com esse ID do seu sistema (lista vazia se
não houver).
Paginação
page_size (1 a 100) liga a paginação, com page a partir de 1. A resposta traz a
página em data, ordenada por id, e pagination com page, page_size e total.
Sem page_size, a lista vem inteira e page é ignorado. include_users=false deixa
sys_users_tenants de fora, com ou sem paginação.
O campo token de cada tenant é o Tenant Token dele, o que autentica as rotas
/tenant. Os dois tokens estão em Autenticação.
Campos
| Campo | Descrição |
|---|---|
id |
ID interno do tenant |
nome |
Nome do tenant |
external_id |
ID do tenant no seu sistema, se informado na criação |
token |
Tenant Token para autenticar em /tenant/* |
status, statusDetail |
Estado do tenant: provisioning, failed, awaiting_credentials, loading ou ready |
dominio |
Domínio de acesso (ex: empresa.horusbi.com.br) |
ativo |
Se o tenant está ativo |
development_variables |
Variáveis globais do ETL, sempre como lista. Variável protegida vem sem value |
config |
Configurações do tenant |
dw_desks, bi_desks |
Mesas de Dados e Mesas de Aplicação |
bi_apps |
Aplicações DataViz |
dw_tables |
Tabelas do HorusDW |
sys_users_tenants |
Usuários vinculados |
Autorizações
clientBearerAuth
Token de acesso do cliente
TipoHTTP (bearer)
Parâmetros
Query Parameters
external_id
Filtra pelo ID do tenant no seu sistema
Tipostring
Example
"1234"page_size
Tenants por página. Liga a paginação
Tipointeger
Example
50Minimum
1Maximum
100page
Número da página, a partir de 1. Ignorado sem page_size
Tipointeger
Example
1Minimum
1Default
1include_users
Com false, cada tenant vem sem sys_users_tenants. Outro valor é ignorado
Tipoboolean
Example
falseRespostas
Tenants do Cliente
application/json
JSON