Profile Server API
Manual do usuário

Tenants

Instâncias de uma aplicação para um cliente, com seus usuários vinculados.

Menu: Tenants (/tenants)

Um tenant é a instância de uma aplicação para um cliente: "o app X rodando para o cliente Y". É nele que os usuários são vinculados para ter acesso.

Área exclusiva do administrador da plataforma

Este menu só aparece para o perfil administrador da plataforma — veja Permissões.

A tela

Lista os tenants. Clicar em um tenant abre a página de detalhe, com os dados completos e o painel de usuários vinculados.

Criar um tenant

Clique em Novo tenant:

CampoObrigatórioObservações
CustomerSimO cliente dono deste tenant. Não pode ser alterado depois.
AppSimA aplicação instanciada. Não pode ser alterado depois.
NomeSimNome do tenant.
DescriçãoNãoTexto exibido no lugar do nome quando o usuário escolhe entre seus tenants — o nome nem sempre é um bom texto de exibição. Sem descrição, o seletor usa o nome.
Keycloak client IDNãoPreencha apenas para integrações app-to-app (avançado).
Escopos permitidosNãoLista separada por vírgula (ex.: cooperatives:read, tenants:read) — uso avançado.
Metadata (JSON)NãoDados extras em formato JSON, para uso das integrações.
AtivoLigado por padrão. Tenants inativos não recebem tráfego.

Customer e App são definitivos

Depois de criado, o tenant não muda de cliente nem de aplicação. Se errou a combinação, exclua e crie novamente.

Página de detalhe

Além dos dados do tenant, o detalhe traz os painéis Organizações e Usuários.

Organizações

Lista as organizações (cooperativas) vinculadas a este tenant, com nome, documento e status. Clicar em uma organização abre a página de detalhe dela.

  • Vincular organização — selecione uma organização já cadastrada e clique em Adicionar. A partir daí este tenant passa a alcançar a organização, e os usuários do tenant passam a enxergar os dados e documentos dela. Organizações já vinculadas não aparecem na lista de seleção.
  • Desvincular — o ícone de lixeira na linha da organização. O tenant deixa de alcançá-la; a organização em si continua cadastrada.

O mesmo vínculo também pode ser feito a partir da página da organização, no sentido contrário.

Desvincular também apaga os escopos por usuário

Se algum usuário deste tenant tinha o acesso restrito a um conjunto de organizações que incluía esta, ela sai desse conjunto. Um usuário cujo acesso estava restrito a esta organização fica sem nenhuma organização no tenant — reveja o acesso dele na página do usuário.

Também é feito pela integração

Esse mesmo vínculo é criado e removido pela integração da aplicação com a plataforma (comunicação entre serviços). Vincular por esta tela e vincular pela integração têm o mesmo efeito.

Usuários

  • Vincular usuário — selecione um usuário já cadastrado e um perfil de acesso (Administrador do tenant, Coordenador, Técnico ou Visualizador) para dar a ele acesso a este tenant com aquele perfil.
  • Cada usuário já vinculado mostra o perfil atual. Religar com outro perfil troca o perfil anterior.
  • Remover vínculo — tira o acesso daquele usuário a este tenant (o cadastro do usuário continua existindo).

O mesmo vínculo também pode ser feito a partir da página do usuário, no sentido contrário.