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

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

Tarefas

Operations

Cadastrar tarefa

Request

Cadastra uma nova tarefa.

Body
required
itemAssociacaoIdstring or nullrequired

Id do item associado

descricaostring or nullrequired

Descrição da tarefa geral

descricaoDetalhadastring or nullrequired

Descrição detalhada da tarefa geral

setorIdstring or nullrequired

Id do setor da tarefa geral

usuarioIdsArray of strings or nullrequired

Array de ids de usuário relacionados a tarefa geral

iniciostring(date-time)required

Data inicial

fimstring(date-time)required

Data final

prioridadeinteger(PrioridadeTarefaGeralEnum)required

Prioridade da tarefa geral

statusinteger(StatusTarefaGeral)required

Status da tarefa geral

permissaointeger or null(NullableOfPermissaoEnum2)required

Permissão relacionada ao item associado

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/tarefas-gerais \
  -H 'Content-Type: application/json' \
  -d '{
    "itemAssociacaoId": "string",
    "descricao": "string",
    "descricaoDetalhada": "string",
    "setorId": "string",
    "usuarioIds": [
      "string"
    ],
    "inicio": "2019-08-24T14:15:22Z",
    "fim": "2019-08-24T14:15:22Z",
    "prioridade": 0,
    "status": 0,
    "permissao": 0
  }'

Responses

OK

Body
idstring or nullrequired
Response
No response example

Atualizar status das tarefas em lote

Request

Atualiza o status de muitas tarefas.

Body
required
idsArray of strings or nullrequired

Arrays de ids as tarefas

statusinteger(StatusTarefaGeral)required

Status da tarefa geral

curl -i -X PATCH \
  https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/tarefas-gerais \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "string"
    ],
    "status": 0
  }'

Responses

OK

Response
No content

Recuperar tarefas com filtros

Request

Recupera tarefas com base em filtros opcionais.

Query
idstring

Id de uma tarefa geral

Default null
descricaostring

Parte da descrição da tarefa geral

Default null
setorIdsArray of strings

Array com id dos setores da tarefa geral

Default null
usuarioIdsArray of strings

Id dos usuários relacionado a tarefa geral

Default null
statusstring

Status da tarefa geral

Default null
prioridadestring

Prioridade da tarefa geral

Default null
permissaostring

Permissão da tarefa geral

Default null
iniciostring(date-time)

Data inicial

Default null
fimstring(date-time)

Data final

Default null
paginainteger(int32)

Número da páginação

Default 1
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/tarefas-gerais?pagina=1&quantidade=10'

Responses

OK

Body
Array [
idstring or nullrequired

Id da tarefa geral

descricaostring or nullrequired

Descrição da tarefa geral

iniciostring(date-time)required

Data inicial

fimstring(date-time)required

Data final

statusinteger(StatusTarefaGeral)required

Status da tarefa geral

prioridadeinteger(PrioridadeTarefaGeralEnum)required

Prioridade da tarefa geral

permissaointeger or null(NullableOfPermissaoEnum2)required

Permissão relacionada ao item associado

itemAssociadoIdstring or nullrequired

Id do item associado

setorobject or null(TarefaSetorResponse)required

Setor da tarefa geral

setor.​idstring or nullrequired

Id do setor

setor.​nomestring or nullrequired

Nome do setor

usuariosArray of objects or null(TarefaUsuarioResponse)required

Usuários relacionados a tarefa geral

usuarios[].​idstring or nullrequired

Id do usuário

usuarios[].​nomestring or nullrequired

Nome do usuário

usuarios[].​imageminteger or null(int64)required

Imagem do usuário

]
Response
No response example

Alterar tarefa

Request

Altera uma tarefa.

Path
idstring(uuid)required

Id da tarefa geral

Body
required
idstring or null

Id da tarefa geral

descricaostring or nullrequired

Descrição da tarefa geral

descricaoDetalhadastring or nullrequired

Descrição detalhada da tarefa geral

setorIdstring or nullrequired

Id do setor da tarefa geral

usuarioIdsArray of strings or nullrequired

Array de ids de usuário relacionados a tarefa geral

iniciostring(date-time)required

Data inicial

fimstring(date-time)required

Data final

prioridadeinteger(PrioridadeTarefaGeralEnum)required

Prioridade da tarefa geral

statusinteger(StatusTarefaGeral)required

Status da tarefa geral

permissaointeger or null(NullableOfPermissaoEnum2)required

Permissão relacionada ao item associado

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/tarefas-gerais/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "descricao": "string",
    "descricaoDetalhada": "string",
    "setorId": "string",
    "usuarioIds": [
      "string"
    ],
    "inicio": "2019-08-24T14:15:22Z",
    "fim": "2019-08-24T14:15:22Z",
    "prioridade": 0,
    "status": 0,
    "permissao": 0
  }'

Responses

OK

Response
No content

Atualizar status da tarefa

Request

Atualiza o status de uma tarefa.

Path
idstring(uuid)required

Id da tarefa geral

Body
required
statusinteger(StatusTarefaGeral)required

Status da tarefa geral

idstring or null

Id da tarefa geral

curl -i -X PATCH \
  'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/tarefas-gerais/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": 0,
    "id": "string"
  }'

Responses

OK

Response
No content

Recuperar tarefa por id

Request

Recupera uma tarefa por id.

Path
idstring(uuid)required

Id da tarefa geral

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/tarefas-gerais/{id}'

Responses

OK

Body
idstring or nullrequired

Id da tarefa geral

descricaostring or nullrequired

Descrição da tarefa geral

descricaoDetalhadastring or nullrequired

Descrição detalhada da tarefa geral

setorobject or null(TarefaSetorResponse)required

Setor da tarefa geral

setor.​idstring or nullrequired

Id do setor

setor.​nomestring or nullrequired

Nome do setor

iniciostring(date-time)required

Data inicial

fimstring(date-time)required

Data final

statusinteger(StatusTarefaGeral)required

Status da tarefa geral

prioridadeinteger(PrioridadeTarefaGeralEnum)required

Prioridade da tarefa geral

itemAssociadoIdstring or nullrequired

Id do item associado

permissaointeger or null(NullableOfPermissaoEnum2)required

Permissão relacionada ao item associado

usuariosArray of objects or null(TarefaUsuarioResponse)required

Array de usuário relacionados a tarefa geral

usuarios[].​idstring or nullrequired

Id do usuário

usuarios[].​nomestring or nullrequired

Nome do usuário

usuarios[].​imageminteger or null(int64)required

Imagem do usuário

cadastrostring(date-time)required

Data do cadastro

ultimaAtualizacaostring or null(date-time)required

Data da última atualização

usuarioCadastradorobject or null(TarefaUsuarioResponse2)required

Usuário cadastrador

usuarioCadastrador.​idstring or nullrequired

Id do usuário

usuarioCadastrador.​nomestring or nullrequired

Nome do usuário

usuarioCadastrador.​imageminteger or null(int64)required

Imagem do usuário

Response
No response example

Deletar tarefa por id

Request

Deleta uma tarefa por id.

Path
idstring(uuid)required

Id da tarefa geral

curl -i -X DELETE \
  'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/tarefas-gerais/{id}'

Responses

OK

Response
No content

Encaminhar uma tarefa para usuários.

Request

Encaminhar uma tarefa para usuários.

Path
idstring(uuid)required

Id da tarefa geral

Body
required
idstring or null

Id da tarefa geral

usuarioIdsArray of strings or nullrequired

Arrays de ids dos usuários

curl -i -X PATCH \
  'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/tarefas-gerais/{id}/encaminhar' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "usuarioIds": [
      "string"
    ]
  }'

Responses

OK

Response
No content