# Acesso Api # API de Autenticação e Gestão de Usuários 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. Version: v1.0.0 ## Servers ``` http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento ``` ## Download OpenAPI description [Acesso Api](https://apidocs.ger26.com.br/_bundle/apis/Acessos/v1.yaml) ## 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. ### Verificar permissão - [GET /api/v1/acessos/verificar-permissao/{permissao}/{acao}](https://apidocs.ger26.com.br/apis/acessos/v1/acessos/paths/~1api~1v1~1acessos~1verificar-permissao~1%7Bpermissao%7D~1%7Bacao%7D/get.md): Verifica se o usuário tem ou não a permissão solicitada. ### Trocar tenant - [GET /api/v1/acessos/trocar-tenant/{tenantId}](https://apidocs.ger26.com.br/apis/acessos/v1/acessos/paths/~1api~1v1~1acessos~1trocar-tenant~1%7Btenantid%7D/get.md): Efetua a troca de tenant para o usuário autenticado. ### Gerar token permanente - [PATCH /api/v1/acessos/token](https://apidocs.ger26.com.br/apis/acessos/v1/acessos/paths/~1api~1v1~1acessos~1token/patch.md): Gera um token de acesso permanente para o usuário autenticado. ### Excluir token de acesso - [DELETE /api/v1/acessos/token](https://apidocs.ger26.com.br/apis/acessos/v1/acessos/paths/~1api~1v1~1acessos~1token/delete.md): Exclui o token de acesso do usuário autenticado. ### Login via token de acesso - [POST /api/v1/acessos/token](https://apidocs.ger26.com.br/apis/acessos/v1/acessos/paths/~1api~1v1~1acessos~1token/post.md): Efetua o login no sistema usando um token de acesso. ## 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. ### Efetuar login - [POST /api/v1/login](https://apidocs.ger26.com.br/apis/acessos/v1/login/paths/~1api~1v1~1login/post.md): Efetua o login no sistema utilizando login e senha. Pode exigir autenticação em dois fatores. ## 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. ### Recuperar um usuário - [GET /api/v1/usuarios/{id}](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios~1%7Bid%7D/get.md): Recupera os dados de um usuário específico pelo ID. ### Alterar usuário - [PUT /api/v1/usuarios/{id}](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios~1%7Bid%7D/put.md): Realiza a alteração dos dados de um usuário. ### Excluir usuário - [DELETE /api/v1/usuarios/{id}](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios~1%7Bid%7D/delete.md): Exclui um usuário do sistema com base no ID. ### Listar usuários ativos - [GET /api/v1/usuarios/ativos](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios~1ativos/get.md): Lista os usuários ativos do sistema. ### Listar usuários - [GET /api/v1/usuarios](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios/get.md): Lista os usuários cadastrados no sistema com filtros opcionais. ### Cadastrar usuário - [POST /api/v1/usuarios](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios/post.md): Cadastra um novo usuário para acesso ao sistema. ### Listar agentes - [GET /api/v1/agentes/{id}/usuarios](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1agentes~1%7Bid%7D~1usuarios/get.md): Lista os agentes cadastrados no sistema com filtros opcionais. ### Listar visão carteira do agente - [GET /api/v1/agentes/{id}/usuarios-visao-carteira](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1agentes~1%7Bid%7D~1usuarios-visao-carteira/get.md): Listar cedentes que o agente tem permissão para enxergar ### Manipular perfis de usuário - [PATCH /api/v1/usuarios/manipular-perfis](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios~1manipular-perfis/patch.md): Manipula os perfis atribuídos a um usuário. ### Alterar preferências do usuário - [PATCH /api/v1/usuarios/{id}/preferencias](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios~1%7Bid%7D~1preferencias/patch.md): Realiza a alteração das preferências do usuário. ### Alterar imagem do usuário - [PATCH /api/v1/usuarios/{id}/imagem](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios~1%7Bid%7D~1imagem/patch.md): Realiza a alteração da imagem de perfil do usuário. ### Verificar existência de usuário - [GET /api/v1/usuarios/verificar](https://apidocs.ger26.com.br/apis/acessos/v1/usuarios/paths/~1api~1v1~1usuarios~1verificar/get.md): Verifica se existe um usuário com o CPF informado e/ou com o CPF e login informados.