FoxIDs Control
O FoxIDs é configurado através do FoxIDs Control, que consiste no Control Client e no Control API. O Control Client e o Control API são protegidos pelo FoxIDs, e o Control Client utiliza o Control API.
Control API contém todas as funcionalidades de configuração. Por conseguinte, é possível automatizar a configuração através da integração com o Control API.
FoxIDs Control Client
O Control Client é uma aplicação Blazor WebAssembly (WASM).
Abra o seu Control Client em FoxIDs.com.
Tenant e ambiente master
Se usar FoxIDs.com, o seu tenant é criado durante o registo.
Se implementar o FoxIDs em self-hosting, obtém acesso ao tenant master. Crie primeiro um tenant para conter a sua configuração de segurança. A maioria das instalações só precisa de um, mas pode configurar um número ilimitado de tenants.

Um tenant contém um ambiente master, a partir do qual todo o tenant é configurado. O ambiente master contém um repositório de utilizadores e, na criação, apenas um utilizador administrador.
Normalmente não deve alterar a configuração do ambiente master nem adicionar novos métodos de autenticação ou registos de aplicações, mas isso é possível. Pode, por exemplo, ao adicionar um método de autenticação, obter single sign-on (SSO) para o ambiente master.
Criar utilizadores administradores
É possível criar mais utilizadores administradores no ambiente master. Um utilizador torna-se administrador ao adicionar o papel de administrador foxids:tenant.admin, como mostrado abaixo.
Crie um utilizador:
- Abra o ambiente master
- Selecione o separador Users
- Clique em Create User
- Adicione a informação do utilizador e clique em Create.

Conceder acesso ao utilizador
O acesso é concedido com papéis. Os scopes só são necessários quando um cliente pede um token para a Control API; o Control Client já pede o scope necessário em foxids_control_api, por isso normalmente apenas atribui papéis ao utilizador no ambiente master.
Para permitir que uma pessoa inicie sessão no Control Client e veja dados de configuração:
- Crie ou abra o utilizador no ambiente
master(separador Users). - Adicione o papel base
foxids:tenant:basic.read(necessário para o Control Client carregar o perfil e ferramentas auxiliares). - Decida o que o utilizador pode ver:
- Para limitar a visibilidade a um ambiente, adicione
foxids:tenant:track[vh2csjt4].read(substituavh2csjt4pelo nome técnico do ambiente). - Para permitir todos os ambientes, adicione
foxids:tenant.read.
- Para limitar a visibilidade a um ambiente, adicione
- Adicione os papéis operacionais de que o utilizador necessita em cada ambiente. Exemplos:
foxids:tenant:track[vh2csjt4]:userpara gerir utilizadores,foxids:tenant:track[vh2csjt4]:partypara gerir aplicações e métodos de autenticação.
Control Client vs apenas API:
- O Control Client (UI interativa) lê dados de perfil e listas de ambientes, além da API específica que pretende gerir. Por isso precisa de
foxids:tenant:basic.readmais um papel de leitura de ambiente (foxids:tenant:track[main].readoufoxids:tenant.read) juntamente com os seus papéis de ação. - Chamadores apenas API podem ser mais restritos. Se um serviço backend apenas chamar a user API para o ambiente
vh2csjt4, o papelfoxids:tenant:track[vh2csjt4]:useré suficiente, juntamente com o pedido do scope correspondente quando usar client credentials. Os papéis extra de leitura não são necessários porque não há dados de UI para carregar.
Ambientes
Um ambiente é um Identity Provider independente com o seu próprio repositório de utilizadores, certificado, métodos de autenticação, registos de aplicações e definições. Utilize ambientes separados para isolar fases como desenvolvimento, teste e produção.
Consulte Ambientes para obter informações sobre a separação, o conteúdo, a criação e a configuração de ambientes.
FoxIDs Control API
A Control API expõe a configuração e administração do FoxIDs como uma REST API segura. O Control Client utiliza a mesma API, pelo que as tarefas de configuração também podem ser automatizadas pelos seus próprios serviços e ferramentas de deployment.
Comece pelo guia da Control API para configurar a autenticação, criar URLs de endpoints, escolher scopes e funções e encontrar guias específicos de recursos.
- Consulte o contrato exato em Swagger (OpenAPI) JSON
- Explore e chame operações através de Swagger UI
Os deployments self-hosted expõem o documento OpenAPI em .../api/swagger/v2/swagger.json e o Swagger UI em .../api/swagger.
Direitos de acesso à API
Consulte os direitos de acesso da Control API para conhecer o modelo de scopes e funções e as tabelas completas de direitos.