엔터프라이즈의 감사 로그 API 사용

REST API를 사용하여 프로그래밍 방식으로 엔터프라이즈 이벤트를 검색하는 방법을 알아봅니다.

누가 이 기능을 사용할 수 있나요?

Enterprise owners and site administrators

이 기사에서

참고

웹후크는 특정 사용 사례에 대한 감사 로그 또는 API 폴링의 좋은 대안이 될 수 있습니다. 웹후크는 리포지토리, 조직 또는 기업에 대해 특정 이벤트가 발생할 때 GitHub에서 서버에 알리는 방법입니다. 기업, 조직 또는 리포지토리에서 특정 이벤트가 발생할 때 이를 탐지하고 기록하려는 경우 API 또는 감사 로그 검색보다 웹후크가 더 효율적일 수 있습니다. 웹후크 설명서을(를) 참조하세요.

감사 로그와 관련된 엔드포인트를 사용하여 규정 준수 및 보안 지적 재산을 유지 관리합니다. 엔터프라이즈 감사 로그에 대한 REST API 엔드포인트 및 조직에 대한 REST API 엔드포인트을(를) 참조하세요.

감사 로그 엔드포인트를 통해 액세스할 수 있는 특정 이벤트에 대한 자세한 정보는 다음 문서를 참조하세요.

  •         [AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)

  •         [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization)

  •         [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/security-log-events)

감사 로그 세부 정보

{ 데이터 재사용 가능.감사_로그.보존_기간 }

API 응답의 타임스탬프 및 날짜 필드는 UTC Epoch 밀리초 단위로 측정됩니다.

          `read:audit_log` 범위를 사용하여 API를 통해 감사 로그에 액세스할 수 있습니다.

예제 1: 페이지를 매긴 특정 날짜에 대한 엔터프라이즈의 모든 이벤트

페이지 기반 페이지 매김을 사용할 수 있습니다. 페이지 매김에 대한 자세한 내용은 REST API에서 페이지 매김 사용을(를) 참조하세요.

아래 쿼리는 avocado-corp 엔터프라이즈에서 2022년 1월 1일에 생성된 감사 로그 이벤트를 검색하고, 페이지 매김을 사용하여 페이지당 최대 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` 기호 또는 ASCII 문자 코드 `actor`으로 구성된 URL에서 구분하여 `+` 및 `%20`와 같은 여러 검색 구문을 지정할 수 있습니다.

아래 쿼리는 avocado-corp 엔터프라이즈에서 2022년 1월 1일 이후에 이벤트가 발생하고 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 활동에 대한 이벤트

URL에 include=git을 매개 변수로 추가하여 엔터프라이즈에서 복제, 페치 및 푸시와 같은 Git 이벤트를 검색할 수 있습니다. 또는 include=all을 사용하여 웹 이벤트 및 Git 이벤트를 모두 검색할 수 있습니다.

아래 쿼리는 avocado-corp 엔터프라이즈에서 2024년 1월 1일 이후에 이벤트가 발생하고 octocat 사용자가 작업을 수행한 Git 활동의 감사 로그 이벤트를 검색합니다.

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"