Pular para o conteúdo principal
Este guia mostra como usar a ferramenta na sua aplicação. Ele cobre setup, configuração e como os serviços Auth e Identity trabalham juntos para gerenciar autenticação e identidade.

Uso típico


O Access Manager foi construído para tornar a autenticação simples, seja gerenciando pessoas reais ou integrações sistema-a-sistema. Veja como ele normalmente se encaixa no seu fluxo de trabalho.
Uma vez que o Access Manager esteja habilitado, todas as requisições de API devem incluir um header Authorization com um Bearer access token válido.Sem esse header, suas requisições serão rejeitadas, mesmo para endpoints públicos ou anteriormente acessíveis.

Acesso humano

Quando você está criando credenciais para uma pessoa, normalmente seguirá estes passos:

Passo 1 - Verificar as permissões do grupo

Primeiro, descubra quais papéis ou permissões você quer que a pessoa tenha. Para isso, você pode listar todos os grupos disponíveis usando o endpoint Listar Grupos.

Passo 2 - Criar o usuário

Uma vez que você tenha os grupos certos em mente, é hora de criar o usuário. Para isso, use o endpoint Criar um Usuário.
  • Adicione-o aos grupos corretos durante a criação para que ele tenha as permissões necessárias desde o primeiro dia.
Gerenciando Usuários Os seguintes endpoints também estão disponíveis para você gerenciar os usuários e seus acessos:

Passo 3 - Solicitar um token usando password

O usuário agora pode autenticar usando suas credenciais. Para isso, use o endpoint Solicitar um Access Token e use password como grantType. Isso retornará um access token que ele pode usar para acessar suas APIs protegidas.

Acesso M2M

Para cenários sistema-a-sistema (machine-to-machine), o fluxo é um pouco diferente, mas igualmente simples.

Passo 1 - Criar uma aplicação

Todo sistema ou serviço que precisa conectar via M2M deve ter sua própria aplicação. Use o endpoint Criar uma Aplicação para configurar o acesso à aplicação Lerian com a qual seu sistema vai se comunicar.
O campo name deve corresponder a um dos nomes de aplicação predefinidos da Lerian. Atualmente, as opções disponíveis são:
  • midaz
  • plugin-fees
  • plugin-crm
  • plugin-smart-template
Os seguintes endpoints também estão disponíveis para você gerenciar as aplicações:

Passo 2 - Solicitar um token usando client credentials

Uma vez que sua aplicação esteja configurada, ela pode se autenticar sem um usuário. Para isso, use o endpoint Solicitar um Access Token e use client_credentials como grantType. Isso retorna um token que o sistema pode usar para chamar APIs de forma segura.

Encerrando sessão do usuário

Se, por algum motivo, você precisar encerrar a sessão de um usuário e revogar seus tokens ativos, garantindo um logout seguro e completo da aplicação, use o endpoint Encerrar Sessão do Usuário.