Acesso Api (v1.0.0)
A API de Autenticação e Gestão de Usuários foi desenvolvida para oferecer controle abrangente sobre o acesso de usuários e o gerenciamento de suas informações no sistema. Com ela, é possível realizar autenticações, controlar permissões, gerenciar tenants e administrar o ciclo de vida completo dos usuários.
Simplificando a gestão de acessos e usuários com a robustez e a flexibilidade de uma API de alta performance!
A seguir, detalhamos as principais funcionalidades oferecidas por cada um dos endpoints.
Acessos
Estes recursos são dedicados ao gerenciamento de permissões e tokens de acesso dos usuários:
- Verificar Permissão:
- Consulta se o usuário autenticado possui uma permissão específica para determinada ação.
- Trocar Tenant:
- Permite ao usuário autenticado alternar o contexto de tenant.
- Gerar Token Permanente:
- Cria um token de acesso de longa duração para o usuário autenticado.
- Excluir Token de Acesso:
- Revoga o token de acesso permanente do usuário autenticado.
Login
Este conjunto de recursos permite a autenticação de usuários e o controle de acesso:
- Efetuar Login:
- Autentica usuários utilizando credenciais de login e senha, com suporte a autenticação de dois fatores.
- Login via Token de Acesso:
- Permite o login no sistema usando um token de acesso permanente.
Usuários
Este conjunto de recursos oferece funcionalidades completas para a administração dos dados dos usuários:
- Cadastrar Usuário:
- Cria um novo registro de usuário no sistema.
- Listar Usuários:
- Obtenha listas de usuários cadastrados, com opções de filtragem por nome, empresa, perfil, tipo de pessoa, setor e paginação. É possível listar também apenas usuários ativos.
- Listar Agentes:
- Obtenha listas de agentes cadastrados, com opções de filtragem por paginação.
- Listar Visão Carteira Agentes:
- Obtenha lista da visão carteira do agente.
- Recuperar Usuário por ID:
- Recupere os dados detalhados de um usuário específico utilizando seu identificador.
- Alterar Usuário:
- Atualiza as informações cadastrais de um usuário existente.
- Manipular Perfis de Usuário:
- Adiciona ou remove perfis atribuídos a um usuário.
- Alterar Preferências do Usuário:
- Modifica as configurações de preferências individuais de um usuário.
- Alterar Imagem do Usuário:
- Permite a atualização da imagem de perfil do usuário.
- Excluir Usuário:
- Remove um registro de usuário do sistema.
- Verificar Existência de Usuário:
- Verifica a existência de um usuário pelo CPF e/ou login.