TECNOLOGIA X - Auditoria - Logs de auditoria
Este artigo contém os seguintes tópicos:
O que são os logs de auditoria
Informações disponíveis
Colunas exibidas na listagem
Como gerar o log de auditoria
Exportar os logs
Política de expiração dos logs
Entidades do domínio platform disponíveis para auditoria
Como interpretar o conteúdo do detalhamento
Observação sobre entidades de outros produtos
O que são os Logs de Auditoria?
Os Logs de Auditoria registram as operações realizadas sobre entidades da plataforma Senior X, permitindo rastrear quem fez o quê e quando. Cada registro de auditoria representa uma ação de criação, edição ou exclusão executada por um usuário sobre um dado específico de algum serviço da plataforma.
Essa funcionalidade é fundamental para fins de rastreabilidade, conformidade com políticas internas e auditorias de segurança, pois mantém um histórico confiável das alterações realizadas no ambiente.
A tela está disponível no caminho Tecnologia \ Administração \ Auditoria \ Logs de auditoria.
Para conceder acesso a outros usuários:
- Seja usuário administrador e acesse Tecnologia > Administração > Autorização > Gestão de Papéis;
- Clique em Editar no papel desejado;
- Em Permissões, adicione a ação Visualizar para o recurso:
-
res://senior.com.br/platform/audit/logs
-
res://senior.com.br/platform/audit/logs
Informações disponíveis
Para consultar os logs é necessário informar ao menos um filtro. Os seguintes filtros estão disponíveis:
- Entidade: a entidade (tipo de dado) cujas operações serão consultadas, como usuários, papéis, configurações, entre outras;
- Domínio: o domínio da plataforma ao qual a entidade pertence;
- Serviço: o serviço específico dentro do domínio selecionado;
- ID do registro: identificador único do registro auditado, útil para rastrear um item específico;
- Termo de busca: texto livre para localizar registros pelo conteúdo auditado;
- Data inicial e Data final: período de datas para delimitar a consulta.
Os filtros de domínio e serviço são preenchidos dinamicamente com base na entidade selecionada.
Colunas exibidas na listagem
Os resultados são apresentados em uma tabela com as seguintes colunas:
- Usuário: login do usuário que realizou a operação;
- Domínio: domínio da plataforma onde a operação ocorreu;
- Serviço: serviço responsável pelo registro auditado;
- Operação: tipo de operação realizada, podendo ser SAVE (criação ou edição) ou REMOVE (exclusão);
- Data/Hora: data e hora em que a operação foi registrada, no formato DD/MM/AAAA HH:mm.
Cada linha da listagem possui um botão de detalhamento que abre um painel com o conteúdo completo do registro auditado, incluindo os dados do objeto antes e após a operação, quando disponíveis. Isso permite visualizar exatamente o que foi alterado.
Como gerar o log de auditoria
1. Acesse a plataforma Senior X com um usuário administrador;
2. Acesse o menu Tecnologia \ Administração \ Auditoria \ Logs de auditoria;
3. Preencha ao menos um filtro, recomenda-se pelo menos informar a entidade e o período desejado;
3. Clique em Pesquisar para carregar os resultados;
4. Clique no botão de detalhamento (ícone de lupa) na linha correspondente para ver o conteúdo completo de um registro.
Exportar os logs
Após realizar uma pesquisa com resultados, é possível exportar os dados encontrados. O botão de exportação fica disponível no canto superior direito da tabela de resultados e oferece os seguintes formatos:
- CSV;
- JSON;
- XLSX.
Após solicitar a exportação, o sistema processa o arquivo e envia uma notificação ao usuário com o link para download quando o processamento for concluído.
- A tela exige que ao menos um filtro seja preenchido antes de exibir resultados. Isso garante que a consulta retorne apenas as informações relevantes para a necessidade do momento.
- O botão de exportação só fica habilitado após uma pesquisa que retorne resultados.
- Os logs possuem uma data de expiração. Registros mais antigos podem não estar mais disponíveis para consulta, dependendo da política de retenção configurada no ambiente.
Política de expiração dos logs
Por padrão, os logs de auditoria são mantidos por até 365 dias.
Entidades do domínio platform disponíveis para auditoria
As entidades exibidas no filtro da tela de Logs de Auditoria são registradas automaticamente pelos serviços da plataforma no momento em que eles são iniciados. Cada serviço declara quais entidades audita e o mecanismo da plataforma intercepta automaticamente as operações de criação, edição e exclusão nessas entidades.
O conteúdo visualizado ao clicar no detalhamento de um log é o payload completo do objeto no momento da operação, em formato JSON. Campos considerados sensíveis, como senhas, são automaticamente excluídos do registro.
A seguir estão as entidades da plataforma Senior X disponíveis para auditoria e as informações que podem ser consultadas em cada uma.
1. Usuário (UserEntity).
Serviço: platform/user.
Registra todas as operações realizadas sobre usuários do tenant. É possível visualizar:
- Login do usuário;
- Nome completo;
- Descrição;
- Situação (bloqueado ou ativo);
- Opção de troca de senha no próximo acesso;
- Isenção de expiração de senha;
- Status interno;
- Endereço de e-mail;
- Se o usuário é administrador do tenant;
- Localidade (locale);
- Datas de criação, alteração e exclusão;
- Tipo de autenticação;
- Data de expiração do usuário;
- Número de telefone;
- Configurações de acessibilidade.
Campos excluídos do log por conterem informações sensíveis: senha e foto do usuário.
2. Papéis de usuário (UserRoleEntity).
Serviço: platform/user_role.
Registra os papéis vinculados ao usuário.
3. Recursos do usuário (UserResourceEntity).
Serviço: platform/user_resource.
Registra os recursos vinculados ao usuário, através dos recursos dos papéis do usuário.
4. Grupo (GroupEntity).
Serviço: platform/user.
Registra operações sobre grupos de usuários. É possível visualizar:
- Nome do grupo;
- Descrição;
- E-mail do grupo;
- Usuários associados ao grupo.
5. Usuário Nomeado (NamedUserEntity).
Serviço: platform/accescontrol.
Registra operações relacionadas ao controle de acesso de usuários nomeados. É possível visualizar as informações referentes ao vínculo entre usuários e licenças de acesso nomeado configuradas no tenant.
6. Papel (RoleEntity).
Serviço: platform/role.
Registra a relação entre usuários e recursos permitidos.
7. Recursos do papel (RoleResourceEntity).
Serviço: platform/role_resource.
Registra a relação entre papel e os recursos e filtros configurados.
Como interpretar o conteúdo do detalhamento
Ao abrir o detalhe de um log, o campo de dados exibe o estado completo do objeto no momento da operação. Para operações do tipo SAVE (criação ou edição), o payload representa os dados do registro após a operação. Para operações do tipo REMOVE (exclusão), o payload representa os dados do registro antes de ser removido.
Exemplo de registro de criação de usuário:
json
{
"name": "joao.silva",
"fullName": "João da Silva",
"email": "joao.silva@empresa.com.br",
"blocked": false,
"changePassword": true,
"authenticationType": "G7",
"locale": "pt-BR"
}
Observação sobre entidades de outros produtos
As entidades listadas acima são as disponíveis nos serviços da plataforma Senior X. Produtos instalados no ambiente, como módulos de RH, ERP, WMS, entre outros, podem registrar suas próprias entidades auditáveis, que também aparecerão como opção no filtro de entidade conforme os serviços desses produtos sejam utilizados e registrem operações.
A lista de entidades disponíveis na tela é dinâmica e reflete as entidades que já tiveram ao menos um evento auditado registrado no tenant.
Nesse artigo estamos tratando apenas as entidades do domínio platform, para mais informações das entidades de produto, entre em contato com o suporte de cada produto.
Para mais informações consulte a documentação da tela Logs de Auditoria.