OK
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.
- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}'{ "id": "string", "nome": "string", "cpf": "string", "login": "string", "perfis": [ { … } ], "identidade": { "numero": "string", "emissao": "2019-08-24T14:15:22Z" }, "nascimento": "2019-08-24T14:15:22Z", "site": "string", "tipoAutenticacaoDoisFatores": 0, "telefones": [ { … } ], "emails": [ { … } ], "enderecos": [ { … } ], "acessos": [ { … } ], "setores": [ { … } ] }
- application/json
- application/*+json
Array de Telefones do Usuário
Array de E-mails do Usuário
Array com Endereços do Usuário
Array com Acessos do Usuário
Array com Setores do Usuário
Número da Identidade do Usuário
- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}' \
-H 'Content-Type: application/json' \
-d '{
"id": "string",
"telefones": [
{
"id": "string",
"numero": "string",
"tipo": 0,
"principal": true,
"whatsapp": true,
"sms": true,
"pessoaId": "string"
}
],
"emails": [
{
"id": "string",
"email": "string",
"principal": true,
"pessoaId": "string"
}
],
"enderecos": [
{
"id": "string",
"logradouro": "string",
"numero": "string",
"semNumero": true,
"complemento": "string",
"cep": "string",
"bairro": "string",
"municipio": "string",
"uf": "string",
"principal": true,
"pessoaId": "string"
}
],
"acessos": [
{
"empresaId": "string",
"tipoPessoaFisica": 0,
"ativo": true
}
],
"setores": [
{
"id": "string"
}
],
"nome": "string",
"login": "string",
"perfilsId": [
"string"
],
"identidade": {
"numero": "string",
"emissao": "2019-08-24T14:15:22Z"
},
"nascimento": "2019-08-24T14:15:22Z",
"site": "string",
"tipoAutenticacaoDoisFatores": [
0
]
}'- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}'- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/ativos
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios/ativos
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/ativos?quantidade=10'[ { "id": "string", "nome": "string", "setores": [ … ] } ]
- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios?quantidade=10&ascendente=true'[ { "id": "string", "nome": "string", "login": "string", "imagem": "string", "perfis": [ … ], "setores": [ … ], "empresas": [ … ] } ]
- application/json
- application/*+json
Array de Telefones do Usuário
Array de E-mails do Usuário
Array com Endereços do Usuário
Array com Acessos do Usuário
Array com os setores do usuário
Número da Identidade do Usuário
- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios \
-H 'Content-Type: application/json' \
-d '{
"cpf": "string",
"telefones": [
{
"numero": "string",
"tipo": 0,
"principal": true,
"whatsapp": true,
"sms": true,
"pessoaId": "string"
}
],
"emails": [
{
"email": "string",
"principal": true,
"pessoaId": "string"
}
],
"enderecos": [
{
"logradouro": "string",
"numero": "string",
"semNumero": true,
"complemento": "string",
"cep": "string",
"bairro": "string",
"municipio": "string",
"uf": "string",
"principal": true,
"pessoaId": "string"
}
],
"acessos": [
{
"empresaId": "string",
"tipoPessoaFisica": 0,
"ativo": true
}
],
"setores": [
{
"id": "string"
}
],
"nome": "string",
"login": "string",
"perfilsId": [
"string"
],
"identidade": {
"numero": "string",
"emissao": "2019-08-24T14:15:22Z"
},
"nascimento": "2019-08-24T14:15:22Z",
"site": "string",
"tipoAutenticacaoDoisFatores": [
0
]
}'No response example- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/agentes/{id}/usuarios
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/agentes/{id}/usuarios
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/agentes/{id}/usuarios?quantidade=10&ascendente=true'[ { "id": "string", "nome": "string", "login": "string", "imagem": "string", "perfis": [ … ], "setores": [ … ], "empresas": [ … ] } ]
- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/agentes/{id}/usuarios-visao-carteira
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/agentes/{id}/usuarios-visao-carteira
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/agentes/{id}/usuarios-visao-carteira?quantidade=10&ascendente=true'[ { "id": "string", "nome": "string", "login": "string", "imagem": "string", "perfis": [ … ], "setores": [ … ], "empresas": [ … ] } ]
- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/manipular-perfis
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios/manipular-perfis
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/manipular-perfis \
-H 'Content-Type: application/json' \
-d '{
"perfilId": "string",
"usuariosId": [
"string"
]
}'- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}/preferencias
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios/{id}/preferencias
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}/preferencias' \
-H 'Content-Type: application/json' \
-d '{
"id": "string",
"tenantIdPadrao": "string",
"preferencias": {
"modoEscuro": true,
"modoEscuroApenasBarra": true,
"modoEscuroApenasHeader": true,
"barraLateralNaDireita": true,
"barraLateralFlutuante": true,
"esconderRodape": true,
"esconderBarraLateral": true
}
}'- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}/imagem
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios/{id}/imagem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/{id}/imagem' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d ContentType=string \
-d ContentDisposition=string \
-d 'Headers[property1]=string' \
-d 'Headers[property2]=string' \
-d Length=0 \
-d Name=string \
-d FileName=string- Mock serverhttps://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/verificar
- http://rgbsys.dyndns.info/ger2025-acesso-api-desenvolvimento/api/v1/usuarios/verificar
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.ger26.com.br/_mock/apis/acessos/v1/api/v1/usuarios/verificar?cpf=string'