Usando a API do log de auditoria
Você pode interagir com o log de auditoria usando a API GraphQL ou a API REST.
Timestamps and date fields in the API response are measured in UTC epoch milliseconds.
Consultando o log auditoria da API do GraphQL
Para garantir que a sua propriedade intelectual esteja protegida e que você mantenha a conformidade para a sua empresa, você pode usar a API do GraphQL do log de auditoria para guardar cópias dos seus dados de log de auditoria e para monitorar:
- O acesso às configurações da sua organização ou repositório
- As alterações nas permissões
- Os usuários adicionados ou removidos em uma organização, repositório ou equipe
- Os usuários promovidos a administradores
- Alterações nas permissões de um aplicativo GitHub
Observe que você não pode recuperar eventos do Git usando a API de registro de auditoria API GraphQL. Para recuperar eventos do Git, use a API REST. Para obter mais informações, consulte as ações da categoria do git emAções do log de auditoria para a sua empresa" e também a "Administração da empresa" e os pontos de extremidade das "Organizações do log de auditoria na documentação da API REST.
A resposta do GraphQL pode incluir dados por até 90 a 120 dias.
Exemplo 1: Integrantes adicionados ou removidos das organizações de uma empresa
A consulta abaixo busca os logs de auditoria da empresa avocado-corp e retorna as primeiras 10 organizações da empresa, em que as únicas ações realizadas estavam adicionando ou removendo um integrante de uma organização. As primeiras 20 entradas de logs de auditoria para cada organização são devolvidas.
Esta consulta usa o campo auditlog do objeto Organização, e os objetos OrgAddMemberAuditEntry e OrgRemoveMemberAuditEntry. A conta de GitHub que consultou o log de auditoria corporativa deve ser o proprietário de uma organização para cada organização dentro da empresa.
{
enterprise(slug: "avocado-corp") {
organizations(first: 10, orderBy: {field: LOGIN, direction: DESC}) {
nodes {
name
auditLog(first: 20) {
edges {
node {
... on OrgAddMemberAuditEntry {
action
actorLogin
createdAt
}
... on OrgRemoveMemberAuditEntry {
action
actorLogin
createdAt
}
}
}
}
}
pageInfo {
hasNextPage
endCursor
}
}
}
}A API do GraphQL retornará, no máximo, 100 nós por consulta. Para recuperar resultados adicionais, você deve implementar a paginação. Para obter mais informações, consulte "limitações de recursos" na documentação da API do GraphQL e Paginação na documentação oficial do GraphQL.
Exemplo 2: Eventos de uma organização, para uma data e ator específicos
Você pode especificar várias frases de pesquisa, como criado e ator, separando-as na sua string de consulta com um espaço.
A consulta abaixo busca todos os logs de auditoria para o projeto avocado-corp que estão relacionados à organização octo-org, em que as ações foram realizadas pelo usuário do octocat em ou após 1 de janeiro de 2022. As primeiras 20 entradas do log de auditoria são retornadas, com a entrada de log mais recente aparecendo primeiro.
Essa consulta usa a interface AuditEntry. A conta de GitHub que consulta o log de auditoria corporativa deve ser um proprietário da organização octo-org.
{
enterprise(slug: "avocado-corp") {
organizations(first: 1, query: "octo-org") {
nodes {
name
auditLog(first: 20, query: "actor:octocat created:>=2022-01-01T00:00:00.000Z", orderBy: {field: CREATED_AT, direction: DESC}) {
edges {
node {
... on AuditEntry {
action
actorLogin
createdAt
user {
name
}
}
}
}
}
}
}
}
}Para obter mais exemplos de consulta, veja o repositporio das amostras da plataforma.
Consultando o log de auditoria da API REST
Para garantir que a sua propriedade intelectual esteja protegida e que você mantenha a conformidade para a sua empresa, você pode usar a API REST do log de auditoria para guardar cópias dos seus dados de log de auditoria e para monitorar:
- O acesso às configurações da sua organização ou repositório
- As alterações nas permissões
- Os usuários adicionados ou removidos em uma organização, repositório ou equipe
- Os usuários promovidos a administradores
- Alterações nas permissões de um aplicativo GitHub
- Eventos do Git, como clonar, buscar e fazer push
The audit log lists events triggered by activities that affect your enterprise within the current month and up to the previous six months. The audit log retains Git events for seven days.
Por padrão, apenas eventos dos últimos três meses são exibidos. Para ver os eventos mais antigos, você deve especificar um intervalo de datas com o parâmetro criado. Para obter mais informações, consulte "Entender a sintaxe de pesquisa".
Para obter mais informações sobre a REST API do log de auditoria, consulte "Administração empresarial" e "Organizações".
Exemplo 1: Todos os eventos de uma empresa, para uma data específica, com paginação
A consulta abaixo procura eventos de log de auditoria criados em 1 de janeiro de 2022 na empresa avocado-corp e retorna a primeira página com um máximo de 100 itens por página usando a Paginação da API REST:
curl -H "Authorization: token TOKEN" \
--request GET \
"https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100"Exemplo 2: Eventos para pull requests em uma empresa, para uma data ou ator específico
Você pode especificar várias frases de pesquisa, como criado e ator, separando-os no seu URL formado com o símbolo + ou código de carctere ASCII %20.
A consulta abaixo pesquisa eventos de log de auditoria para pull requests, em que o evento ocorreu em ou depois de 1 de janeiro de 2022 na empresa avocado-corp e a ação foi realizada pelo usuário do octocat:
curl -H "Authorization: token TOKEN" \
--request GET \
"https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat"