Skip to content

Criar usuário​

POST
/tenant/users

Cria o usuário e o põe no Tenant. Login que já está neste Tenant é recusado.

O usuário é um só na plataforma: login que já existe em outro tenant é vinculado a este, sem criar outro. Nesse caso password é ignorado (vale a senha atual) e nome muda o nome do usuário em todos os tenants dele.

Sem password, o usuário nasce sem senha e entra só pelo login transparente (POST /tenant/login).

O grupo de administrador não pode ser atribuído pela API.

O vínculo com o tenant é gravado antes das permissões. Se um ID de groups, bi_desks ou apps_deny for recusado, a resposta é de erro, mas o usuário já está no tenant: repetir a chamada responde Login já está cadastrado. Corrija com PUT /tenant/users.

Acessos iniciais

Campo Descrição
groups IDs dos grupos
bi_desks IDs das Mesas de Aplicação a liberar
apps_deny IDs das Aplicações a bloquear
tables Tabelas a liberar, com filtro de linha

O filtro de linha vai em tables: cada item libera uma tabela, com os filtros, as colunas ocultas e a permissão de exportar. Não precisa de Datamart, e a liberação feita por Datamart não muda com este campo. Exemplos em Filtrar as linhas de cada usuário.

Mensagens de erro

Mensagem Causa
Login já está cadastrado Usuário já vinculado ao tenant
O grupo de administrador não pode ser atribuído pela API. groups inclui o grupo administrador
Limite de N usuário(s) atingido... Franquia de usuários do tenant esgotada. Volta como HTTP 409 (até 28/10/2026, 500 com a mensagem só no campo error)
App {id} não encontrado ID em apps_deny não existe
Mesa de aplicação {id} não encontrada ID em bi_desks não existe
Grupo {id} não encontrado ID em groups não existe
Liberação de tabela inválida: ... Item de tables com coluna de outra tabela, operador sem o valor que pede ou tabela que não é do tenant (400, TABLE_ACCESS_INVALID)

Os não encontrados respondem 404; o grupo Administradores, 403.

Autorizações​

tenantBearerAuth

Token de acesso do tenant

TipoHTTP (bearer)

Corpo da Requisição​

application/json
JSON

Respostas​

Operação processada

application/json
JSON

Playground​

Autorização
Corpo

Exemplos​

Desenvolvido por VitePress OpenAPI