Os Logs de Auditoria do Apidog registram atividades relacionadas à segurança suportadas no nível da organização. Proprietários e Administradores da Organização podem usá-los para identificar quem realizou uma ação, quando ela ocorreu, o endereço IP de origem e o recurso da organização afetado.
Este tutorial aborda filtragem, investigação, exportação CSV e coleta baseada em API. Estes registros são logs de auditoria administrativa; eles não são logs de solicitação de API de produção ou de acesso ao gateway.
Antes de começar
- Logs de Auditoria estão disponíveis no plano Enterprise SaaS.
- Eles não estão atualmente disponíveis no Apidog On-Premises.
- Somente Proprietários da Organização e Administradores da Organização podem visualizá-los, exportá-los ou consultá-los.
- Os dados dos logs de auditoria são retidos por 180 dias.
Se sua investigação puder se estender além de 180 dias, exporte ou colete os registros necessários antes que expirem.
Passo 1: Abrir Logs de Auditoria
Abra sua organização Apidog e vá para Logs de Auditoria nas configurações da organização.
A tabela inclui:
- ator
- evento
- descrição
- endereço IP
- hora
Logs de Auditoria fornecem registros de nível de organização para eventos de segurança e administração suportados.
Eventos de autenticação aparecem apenas quando o Apidog pode atribuí-los de forma confiável à organização.
Passo 2: Definir a janela de investigação
Comece com uma pergunta específica, como:
- Quem mudou a função de um membro na organização?
- Quando um token de acesso foi rotacionado ou revogado?
- Qual conta alterou a configuração de SSO?
- Quem alterou uma configuração de acesso a um Site de Documentos ou documento compartilhado?
- Um usuário foi provisionado ou removido via SCIM?
Use o menor intervalo de tempo prático. As predefinições disponíveis incluem os últimos 7, 30, 90 e 180 dias. Você também pode selecionar um intervalo personalizado dentro do período de retenção de 180 dias.
Registre o fuso horário usado por seu processo de incidente ou auditoria antes de comparar esses eventos com logs de provedores de identidade, tickets, Git ou serviços.
Passo 3: Aplicar filtros
Filtre a tabela por:
- Intervalo de tempo - quando o evento pode ter ocorrido.
- Evento - a ação relevante, como mudança de função, falha de login, alteração de token de acesso ou exportação de log de auditoria.
- Ator - o usuário ou integração que realizou a ação.
Combine filtros de tempo, evento e ator para isolar os registros necessários para uma investigação.
Se você não souber o ator, comece com tempo e evento. Se o nome do evento for incerto, comece com o ator e um curto intervalo de tempo.
Passo 4: Revisar os detalhes do evento
Para cada linha relevante, capture:
- o horário do evento
- o ator ou integração
- a ação e descrição
- o endereço IP de origem
- o membro, equipe, configuração ou recurso afetado
Em seguida, correlacione o evento com a fonte que pode responder à próxima pergunta:
| Pergunta | Evidência adicional |
|---|---|
| A ação foi aprovada? | Solicitação de mudança, revisão de acesso ou ticket |
| O login era esperado? | Logs de login e dispositivo do provedor de identidade |
| Qual tráfego de API seguiu? | Logs de acesso do gateway, aplicativo ou API |
| Qual conteúdo mudou? | Histórico de recursos, diff de especificação ou histórico Git |
| Uma credencial foi usada? | Logs do sistema que emitiu a credencial |
Um evento de auditoria mostra que uma ação suportada ocorreu. Ele não prova por si só que a ação foi autorizada, segura ou conforme.
Passo 5: Exportar os resultados filtrados para CSV
Após os filtros estarem corretos:
- revise o conjunto de resultados visíveis
- selecione a opção de exportação CSV
- armazene o arquivo no local de investigação ou auditoria aprovado
- registre o horário da exportação, os critérios de filtro e a pessoa que manuseia o arquivo
A exportação CSV usa os filtros atualmente aplicados à página de Logs de Auditoria e inclui registros correspondentes dentro do período de retenção de 180 dias.
A exportação de Logs de Auditoria é, por si só, registrada nos Logs de Auditoria. O CSV resultante é uma cópia separada, portanto, proteja-o com controles de acesso, retenção e integridade apropriados.
Passo 6: Coletar Logs de Auditoria com a API
Organizações Enterprise podem consultar registros programaticamente através da API de Logs de Auditoria. A API suporta consultas de janela de tempo e paginação por cursor dentro do período de retenção de 180 dias.
Para um processo de coleta agendado:
- escolha um intervalo de coleta menor que a janela de retenção
- consulte um horário de início e término definidos
- siga a paginação por cursor até que o conjunto de resultados esteja completo
- armazene o ponto de verificação da coleta
- tente novamente as janelas com falha sem criar lacunas silenciosas
- proteja o destino de acordo com sua sensibilidade e política de retenção
Cada consulta de API é registrada como um resumo que pode incluir o chamador, endereço IP, janela de consulta, limite, resultado e carimbo de data/hora. O payload completo retornado não é copiado para os metadados desse evento.
Valide a referência atual da API antes de implementar autenticação, caminhos de endpoint, parâmetros de solicitação ou análise de resposta. Não copie um exemplo de código não verificado para um coletor de produção.
Verificar o registro da investigação
Antes de encerrar uma investigação, confirme que você:
- salvou o intervalo de tempo exato e os filtros usados
- capturou todas as páginas de resultados relevantes
- preservou o CSV original ou a resposta da API em um local aprovado
- correlacionou ações importantes com evidências de identidade, gerenciamento de mudanças e tempo de execução
- documentou quaisquer lacunas causadas por retenção, atribuição ou tipos de evento não suportados
Para alterações de acesso, verifique também o estado atual. Um log pode mostrar que uma função mudou, mas a página do membro mostra qual função está atribuída agora.
Manuseio de dados sensíveis
O Apidog aplica a mesma política de redação à página de Logs de Auditoria, exportações CSV e respostas da API. Registros de auditoria não expõem valores de token, senhas, valores secretos, asserções SAML brutas, tokens de redefinição, chaves privadas ou conteúdo de arquivos exportados.
Metadados ainda podem ser sensíveis. Restrinja o acesso a registros exportados e evite colocá-los em tickets públicos ou documentos compartilhados.
Solução de problemas
| Problema | O que verificar |
|---|---|
| A página de Logs de Auditoria está indisponível | Confirme se a organização usa Enterprise SaaS e se o visualizador é um Proprietário ou Administrador da Organização. |
| Um evento de autenticação esperado está faltando | Eventos de autenticação aparecem apenas quando o Apidog pode atribuí-los de forma confiável à organização. Verifique também o provedor de identidade. |
| O CSV contém menos registros do que o esperado | Revise os filtros ativos de tempo, evento e ator. A exportação usa os filtros atuais. |
| Um coletor de API pula registros | Verifique a janela de consulta, o manuseio do cursor, as tentativas e o limite de 180 dias. |
| Chamadas de API de tempo de execução estão faltando | Use logs de acesso do gateway, aplicativo ou API. Os Logs de Auditoria do Apidog são logs administrativos da organização. |
Limitações importantes
Logs de Auditoria não fornecem logs de solicitação de produção, Histórico de Recursos, rollback ou recuperação completa em nível de campo. Conectores SIEM nativos, Syslog, encaminhamento genérico de webhook e streaming em tempo real não são atualmente suportados. A coleta agendada de API é a opção documentada para enviar registros para um pipeline de monitoramento ou auditoria externo.
Tutoriais relacionados sobre governança de API:
Estes tutoriais cobrem controles complementares para governar um espaço de trabalho de API empresarial:
- Estrutura de Governança de API — conecta propriedade, controles, evidências e decisões de ciclo de vida.
- Mapeamento de Grupo SAML com Microsoft Entra ID — atribui acesso à equipe a partir de grupos de provedores de identidade.
- Secret Scanner — revisa possíveis credenciais expostas em ativos Apidog suportados.
- Logs de Auditoria — investiga e exporta atividades administrativas da organização.
- Provisionamento SCIM — gerencia usuários da organização através do ciclo de vida da identidade.
- Políticas Empresariais — configura controles de credenciais, associação, sessão SSO e convites.
- Equipes de API de Autoatendimento Governadas — permite equipes criadas por membros enquanto mantém a supervisão da propriedade.
- Integração GitHub Enterprise Cloud — conecta repositórios GHE.com suportados para fluxos de trabalho OpenAPI.
Documentação oficial relacionada: