Skip to content

Acesso Api (v1.0.0)

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.

Download OpenAPI description
v1.json
v1.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/apis/acessos/v1/
http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/

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.
Operations

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.
Operations

Efetuar login

Request

Efetua o login no sistema utilizando login e senha. Pode exigir autenticação em dois fatores.

Body
required
loginstring or nullrequired

Login do usuário

senhastring or nullrequired

Senha do usuário

codigoAutenticacaointeger or null(int32)

Código de autenticação dois fatores

Default null
curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/login \
  -H 'Content-Type: application/json' \
  -d '{
    "login": "string",
    "senha": "string",
    "codigoAutenticacao": null
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id do usuário

nomestring or nullrequired

Nome do usuário

emailstring or nullrequired

Email do usuário

preferenciasstring or nullrequired

Preferências do usuário

imagemstring or nullrequired

Imagem do usuário

permissoesArray of objects or null(PermissaoResponse)required

Lista de permissões dentro de um tenant que o usuário tem acesso

permissoes[].​idinteger or null(NullableOfPermissaoEnum)required

Id da permissão

permissoes[].​acessointeger or null(int32)required

Nome da permissão

tenantsArray of objects or null(LoginTenantResponse)required

Lista de tenants que o usuário tem acesso

tenants[].​idstring or nullrequired

Id do tenant

tenants[].​apelidostring or nullrequired

Apelido do tenant

tenants[].​empresasArray of objects or null(TenantEmpresaResponse)required

Lista de empresas dentro do tenant que o usuário tem acesso

tenants[].​empresas[].​idstring or nullrequired

Id da empresa

tenants[].​empresas[].​nomestring or nullrequired

Nome da empresa

tokenstring or null

Token para acesso ao sistema

Response
application/json
{
  "id": "string",
  "nome": "string",
  "email": "string",
  "preferencias": "string",
  "imagem": "string",
  "permissoes": [
    { … }
  ],
  "tenants": [
    { … }
  ],
  "token": "string"
}

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.
Operations