Использование API журнала аудита для предприятия

Узнайте, как программно извлекать корпоративные события с помощью REST API.

Кто может использовать эту функцию?

Enterprise owners and site administrators

В этой статье

Примечание.

Веб-перехватчики могут быть хорошей альтернативой журналу аудита или опросу API для определенных вариантов использования. Веб-перехватчики — это способ GitHub для уведомления сервера о конкретных событиях для репозитория, организации или предприятия. По сравнению с API или поиском в журнале аудита веб-перехватчики могут быть более эффективными, если вы просто хотите узнать и, возможно, журнал при возникновении определенных событий в организации, организации или репозитории. См . раздел AUTOTITLE.

Обеспечение соответствия требованиям и защита интеллектуальной собственности с конечными точками, связанными с журналом аудита. См. раздел [AUTOTITLE и Конечные точки REST API для журналов аудита предприятия](/rest/orgs#get-the-audit-log-for-an-organization).

Дополнительные сведения о конкретных событиях, которые можно получить через конечные точки журнала аудита, см. в следующих статьях.

Сведения журнала аудита

Журнал аудита перечисляет события, активируемые действиями, влияющими на ваше предприятиеот ghes %}. Журналы аудита для GitHub хранятся неограниченное время, если владелец предприятия не настроил другой период хранения. См. Настройка журнала аудита для предприятия. за последние 180 дней. События Git хранятся в журнале аудита семь дней —

По умолчанию отображаются только события за последние три месяца. Чтобы увидеть старые события, необходимо указать диапазон дат с параметром created. См . раздел AUTOTITLE.

Метки времени и поля даты в ответе API измеряются в миллисекундах эпохи UTC.

Область можно использовать read:audit_log для доступа к журналу аудита через API.

Пример 1. Все события предприятия для определенной даты с разбиением на страницы

Можно использовать page-based на страницы. Дополнительные сведения о разбиении на страницы см. в разделе Использование разбиения на страницы в REST API.

Приведенный ниже запрос ищет события журнала аудита, созданные 1 января 2022 года в avocado-corp организации, и возвращает первую страницу с максимальной 100 элементами на страницу с помощью разбиения на страницы. Дополнительные сведения о разбиении на страницы см. в разделе Использование разбиения на страницы в REST API.

curl -H "Authorization: Bearer TOKEN" \
--request GET \
"http(s)://HOSTNAME/api/v3/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100"

Пример 2. События для запросов на вытягивание в предприятии для определенной даты и субъекта

Можно указать несколько фраз для поиска, например created или actor, разделив их в сформированном URL-адресе символом + или кодом %20 символа ASCII.

Приведенный ниже запрос выполняет поиск событий журнала аудита для запросов на вытягивание, где событие произошло 1 января 2022 г. или после этой даты в предприятии avocado-corp, а действие выполнил пользователь octocat:

curl -H "Authorization: Bearer TOKEN" \
--request GET \
"http(s)://HOSTNAME/api/v3/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat"

Пример 3. События для действий Git в организации для определенной даты и субъекта

Вы можете искать события Git в организации, например клонирование, получение и отправку, добавив include=git в URL-адрес в качестве параметра. Кроме того, можно использовать include=all для поиска веб-событий и событий Git.

В приведенном ниже запросе выполняется поиск событий журнала аудита для действия Git, где событие произошло после 1 января 2024 г. в avocado-corp организации, а действие было выполнено пользователем octocat .

curl -H "Authorization: Bearer TOKEN" \
--request GET \
"http(s)://HOSTNAME/api/v3/enterprises/avocado-corp/audit-log?phrase=created:>=2024-01-01+actor:octocat&include=git"