엔터프라이즈 감사 로그에 대한 REST API 엔드포인트
REST API를 사용하여 엔터프라이즈에 대한 감사 로그를 검색합니다.
참고
이러한 엔드포인트는 personal access token (classic)을(를) 사용하는 인증만 지원합니다. 자세한 내용은 개인용 액세스 토큰 관리을(를) 참조하세요.
Get the audit log for an enterprise
Gets the audit log for an enterprise.
The authenticated user must be an enterprise admin to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
"Get the audit log for an enterprise"에 대한 세분화된 액세스 토큰
이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:
세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:
- "Enterprise administration" enterprise permissions (read)
"Get the audit log for an enterprise"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
enterprise string 필수The slug version of the enterprise name. |
| 이름, 유형, 설명 |
|---|
phrase string A search phrase. For more information, see Searching the audit log. |
include string The event types to include:
The default is 다음 중 하나일 수 있습니다.: |
after string A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. |
before string A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. |
order string The order of audit log events. To list newest events first, specify The default is 다음 중 하나일 수 있습니다.: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: |
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: |
"Get the audit log for an enterprise"에 대한 HTTP 응답 상태 코드
| 상태 코드 | 설명 |
|---|---|
200 | OK |
"Get the audit log for an enterprise"에 대한 코드 샘플
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/audit-logResponse
Status: 200[
{
"actor_ip": "88.123.45.123",
"from": "pull_requests#merge",
"device_cookie": null,
"actor": "mona-admin",
"actor_id": 7,
"repo": "octo-org/octo-repo",
"repo_id": 17,
"business": "github",
"business_id": 1,
"org": "octo-org",
"org_id": 8,
"action": "pull_request.merge",
"@timestamp": 1635940599755,
"created_at": 1635940599755,
"operation_type": "modify",
"actor_location": {
"country_code": "GB",
"country_name": "United Kingdom",
"region": "ENG",
"region_name": "England",
"city": "Louth",
"postal_code": "LN11",
"location": {
"lat": 53.4457,
"lon": 0.141
}
},
"data": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...",
"method": "POST",
"request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188",
"server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b",
"request_category": "other",
"controller_action": "merge",
"url": "https://example.com/octo-org/octo-repo/pull/1/merge",
"client_id": 322299977.1635936,
"referrer": "https://example.com/octo-org/octo-repo/pull/1",
"actor_session": 1,
"pull_request_id": 1,
"category_type": "Resource Management"
}
},
{
"actor_ip": "88.123.45.123",
"from": "pull_request_review_events#create",
"device_cookie": null,
"actor": "mona-admin",
"actor_id": 7,
"business_id": 1,
"org_id": 8,
"action": "pull_request_review.submit",
"@timestamp": 1635940593079,
"created_at": 1635940593079,
"operation_type": "modify",
"actor_location": {
"country_code": "GB",
"country_name": "United Kingdom",
"region": "ENG",
"region_name": "England",
"city": "Louth",
"postal_code": "LN11",
"location": {
"lat": 53.4457,
"lon": 0.141
}
},
"data": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...",
"method": "PUT",
"request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b",
"server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89",
"request_category": "other",
"controller_action": "create",
"url": "https://example.com/octo-org/octo-repo/pull/1/reviews",
"client_id": 322299977.1635936,
"referrer": "https://example.com/octo-org/octo-repo/pull/1/files",
"actor_session": 1,
"spammy": false,
"pull_request_id": 1,
"body": null,
"allowed": true,
"id": 1,
"state": 40,
"issue_id": 1,
"review_id": 1,
"category_type": "Resource Management"
}
},
{
"actor_ip": "88.123.45.123",
"from": "pull_requests#create",
"device_cookie": null,
"actor": "mona",
"actor_id": 9,
"user_id": 9,
"repo": "octo-org/octo-repo",
"repo_id": 17,
"business": "github",
"business_id": 1,
"org": "octo-org",
"org_id": 8,
"action": "pull_request.create",
"@timestamp": 1635940554161,
"created_at": 1635940554161,
"operation_type": "create",
"actor_location": {
"country_code": "GB",
"country_name": "United Kingdom",
"region": "ENG",
"region_name": "England",
"city": "Louth",
"postal_code": "LN11",
"location": {
"lat": 53.4457,
"lon": 0.141
}
},
"data": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...",
"method": "POST",
"request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305",
"server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b",
"request_category": "other",
"controller_action": "create",
"url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1",
"client_id": 386351111.163594,
"referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1",
"actor_session": 2,
"pull_request_id": 1,
"category_type": "Resource Management"
}
}
]Get the audit log stream key for encrypting secrets
Retrieves the audit log streaming public key for encrypting secrets.
When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "Encrypting secrets for the REST API."
"Get the audit log stream key for encrypting secrets"에 대한 세분화된 액세스 토큰
이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.
"Get the audit log stream key for encrypting secrets"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
enterprise string 필수The slug version of the enterprise name. |
"Get the audit log stream key for encrypting secrets"에 대한 HTTP 응답 상태 코드
| 상태 코드 | 설명 |
|---|---|
200 | The stream key for the audit log streaming configuration was retrieved successfully. |
"Get the audit log stream key for encrypting secrets"에 대한 코드 샘플
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/audit-log/stream-keyThe stream key for the audit log streaming configuration was retrieved successfully.
Status: 200{
"key_id": "123",
"key": "actual-public-key-value"
}List audit log stream configurations for an enterprise
Lists the configured audit log streaming configurations for an enterprise. This only lists configured streams for supported providers.
When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "Encrypting secrets for the REST API."
"List audit log stream configurations for an enterprise"에 대한 세분화된 액세스 토큰
이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.
"List audit log stream configurations for an enterprise"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
enterprise string 필수The slug version of the enterprise name. |
"List audit log stream configurations for an enterprise"에 대한 HTTP 응답 상태 코드
| 상태 코드 | 설명 |
|---|---|
200 | OK |
"List audit log stream configurations for an enterprise"에 대한 코드 샘플
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/audit-log/streamsOK
Status: 200[
{
"id": 1,
"stream_type": "Splunk",
"stream_details": "US",
"enabled": true,
"created_at": "2024-06-06T08:00:00Z",
"updated_at": "2024-06-06T08:00:00Z",
"paused_at": null
}
]Create an audit log streaming configuration for an enterprise
Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.
When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "Encrypting secrets for the REST API."
"Create an audit log streaming configuration for an enterprise"에 대한 세분화된 액세스 토큰
이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.
"Create an audit log streaming configuration for an enterprise"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
enterprise string 필수The slug version of the enterprise name. |
| 이름, 유형, 설명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
enabled boolean 필수This setting pauses or resumes a stream. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stream_type string 필수The audit log streaming provider. The name is case sensitive. 다음 중 하나일 수 있습니다.: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vendor_specific object 필수 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Can be one of these objects:
AzureHubConfig object Azure Event Hubs Config for audit log streaming configuration. Properties of |
| 이름, 유형, 설명 |
|---|
name string 필수Instance name of Azure Event Hubs |
encrypted_connstring string 필수Encrypted Connection String for Azure Event Hubs |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
AmazonS3OIDCConfig object Amazon S3 OIDC Config for audit log streaming configuration.
Properties of AmazonS3OIDCConfig
| 이름, 유형, 설명 |
|---|
bucket string 필수Amazon S3 Bucket Name. |
region string 필수AWS S3 Bucket Region. |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
authentication_type string 필수Authentication Type for Amazon S3. 값: |
arn_role string 필수 |
AmazonS3AccessKeysConfig object Amazon S3 Access Keys Config for audit log streaming configuration.
Properties of AmazonS3AccessKeysConfig
| 이름, 유형, 설명 |
|---|
bucket string 필수Amazon S3 Bucket Name. |
region string 필수Amazon S3 Bucket Name. |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
authentication_type string 필수Authentication Type for Amazon S3. 값: |
encrypted_secret_key string 필수Encrypted AWS Secret Key. |
encrypted_access_key_id string 필수Encrypted AWS Access Key ID. |
SplunkConfig object Splunk Config for Audit Log Stream Configuration
Properties of SplunkConfig
| 이름, 유형, 설명 |
|---|
domain string 필수Domain of Splunk instance. |
port integer 필수The port number for connecting to Splunk. |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_token string 필수Encrypted Token. |
ssl_verify boolean 필수SSL verification helps ensure your events are sent to your Splunk endpoint securely. |
HecConfig object Hec Config for Audit Log Stream Configuration
Properties of HecConfig
| 이름, 유형, 설명 |
|---|
domain string 필수Domain of Hec instance. |
port integer 필수The port number for connecting to HEC. |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_token string 필수Encrypted Token. |
path string 필수Path to send events to. |
ssl_verify boolean 필수SSL verification helps ensure your events are sent to your HEC endpoint securely. |
GoogleCloudConfig object Google Cloud Config for audit log streaming configuration.
Properties of GoogleCloudConfig
| 이름, 유형, 설명 |
|---|
bucket string 필수Google Cloud Bucket Name |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_json_credentials string 필수 |
DatadogConfig object Datadog Config for audit log streaming configuration.
Properties of DatadogConfig
| 이름, 유형, 설명 |
|---|
encrypted_token string 필수Encrypted Splunk token. |
site string 필수Datadog Site to use. 다음 중 하나일 수 있습니다.: |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
"Create an audit log streaming configuration for an enterprise"에 대한 HTTP 응답 상태 코드
| 상태 코드 | 설명 |
|---|---|
200 | The audit log stream configuration was created successfully. |
"Create an audit log streaming configuration for an enterprise"에 대한 코드 샘플
요청 예제
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/audit-log/streams \
-d '{"enabled":false,"stream_type":"Azure Event Hubs","vendor_specific":{"namespace":"newnamespace","shared_access_key_name":"newaccesskeyname","shared_access_key":"newaccesskey","event_hub_name":"neweventhub"}}'The audit log stream configuration was created successfully.
Status: 200{
"id": 1,
"stream_type": "Splunk",
"stream_details": "US",
"enabled": true,
"created_at": "2024-06-06T08:00:00Z",
"updated_at": "2024-06-06T08:00:00Z",
"paused_at": null
}List one audit log streaming configuration via a stream ID
Lists one audit log stream configuration via a stream ID.
When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "Encrypting secrets for the REST API."
"List one audit log streaming configuration via a stream ID"에 대한 세분화된 액세스 토큰
이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.
"List one audit log streaming configuration via a stream ID"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
enterprise string 필수The slug version of the enterprise name. |
stream_id integer 필수The ID of the audit log stream configuration. |
"List one audit log streaming configuration via a stream ID"에 대한 HTTP 응답 상태 코드
| 상태 코드 | 설명 |
|---|---|
200 | Lists one audit log stream configuration via stream ID. |
"List one audit log streaming configuration via a stream ID"에 대한 코드 샘플
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/audit-log/streams/STREAM_IDLists one audit log stream configuration via stream ID.
Status: 200{
"id": 1,
"stream_type": "Splunk",
"stream_details": "US",
"enabled": true,
"created_at": "2024-06-06T08:00:00Z",
"updated_at": "2024-06-06T08:00:00Z",
"paused_at": null
}Update an existing audit log stream configuration
Updates an existing audit log stream configuration for an enterprise.
When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "Encrypting secrets for the REST API."
"Update an existing audit log stream configuration"에 대한 세분화된 액세스 토큰
이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.
"Update an existing audit log stream configuration"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
enterprise string 필수The slug version of the enterprise name. |
stream_id integer 필수The ID of the audit log stream configuration. |
| 이름, 유형, 설명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
enabled boolean 필수This setting pauses or resumes a stream. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stream_type string 필수The audit log streaming provider. The name is case sensitive. 다음 중 하나일 수 있습니다.: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vendor_specific object 필수 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Can be one of these objects:
AzureHubConfig object Azure Event Hubs Config for audit log streaming configuration. Properties of |
| 이름, 유형, 설명 |
|---|
name string 필수Instance name of Azure Event Hubs |
encrypted_connstring string 필수Encrypted Connection String for Azure Event Hubs |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
AmazonS3OIDCConfig object Amazon S3 OIDC Config for audit log streaming configuration.
Properties of AmazonS3OIDCConfig
| 이름, 유형, 설명 |
|---|
bucket string 필수Amazon S3 Bucket Name. |
region string 필수AWS S3 Bucket Region. |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
authentication_type string 필수Authentication Type for Amazon S3. 값: |
arn_role string 필수 |
AmazonS3AccessKeysConfig object Amazon S3 Access Keys Config for audit log streaming configuration.
Properties of AmazonS3AccessKeysConfig
| 이름, 유형, 설명 |
|---|
bucket string 필수Amazon S3 Bucket Name. |
region string 필수Amazon S3 Bucket Name. |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
authentication_type string 필수Authentication Type for Amazon S3. 값: |
encrypted_secret_key string 필수Encrypted AWS Secret Key. |
encrypted_access_key_id string 필수Encrypted AWS Access Key ID. |
SplunkConfig object Splunk Config for Audit Log Stream Configuration
Properties of SplunkConfig
| 이름, 유형, 설명 |
|---|
domain string 필수Domain of Splunk instance. |
port integer 필수The port number for connecting to Splunk. |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_token string 필수Encrypted Token. |
ssl_verify boolean 필수SSL verification helps ensure your events are sent to your Splunk endpoint securely. |
HecConfig object Hec Config for Audit Log Stream Configuration
Properties of HecConfig
| 이름, 유형, 설명 |
|---|
domain string 필수Domain of Hec instance. |
port integer 필수The port number for connecting to HEC. |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_token string 필수Encrypted Token. |
path string 필수Path to send events to. |
ssl_verify boolean 필수SSL verification helps ensure your events are sent to your HEC endpoint securely. |
GoogleCloudConfig object Google Cloud Config for audit log streaming configuration.
Properties of GoogleCloudConfig
| 이름, 유형, 설명 |
|---|
bucket string 필수Google Cloud Bucket Name |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_json_credentials string 필수 |
DatadogConfig object Datadog Config for audit log streaming configuration.
Properties of DatadogConfig
| 이름, 유형, 설명 |
|---|
encrypted_token string 필수Encrypted Splunk token. |
site string 필수Datadog Site to use. 다음 중 하나일 수 있습니다.: |
key_id string 필수Key ID obtained from the audit log stream key endpoint used to encrypt secrets. |
"Update an existing audit log stream configuration"에 대한 HTTP 응답 상태 코드
| 상태 코드 | 설명 |
|---|---|
200 | Successful update |
422 | Validation error |
"Update an existing audit log stream configuration"에 대한 코드 샘플
요청 예제
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/audit-log/streams/STREAM_ID \
-d '{"enabled":false,"stream_type":"Azure Event Hubs","vendor_specific":{"namespace":"newnamespace","shared_access_key_name":"newaccesskeyname","shared_access_key":"newaccesskey","event_hub_name":"neweventhub"}}'Successful update
Status: 200{
"id": 1,
"stream_type": "Splunk",
"stream_details": "US",
"enabled": true,
"created_at": "2024-06-06T08:00:00Z",
"updated_at": "2024-06-06T08:00:00Z",
"paused_at": null
}Delete an audit log streaming configuration for an enterprise
Deletes an existing audit log stream configuration for an enterprise.
When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "Encrypting secrets for the REST API."
"Delete an audit log streaming configuration for an enterprise"에 대한 세분화된 액세스 토큰
이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.
"Delete an audit log streaming configuration for an enterprise"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
enterprise string 필수The slug version of the enterprise name. |
stream_id integer 필수The ID of the audit log stream configuration. |
"Delete an audit log streaming configuration for an enterprise"에 대한 HTTP 응답 상태 코드
| 상태 코드 | 설명 |
|---|---|
204 | The audit log stream configuration was deleted successfully. |
"Delete an audit log streaming configuration for an enterprise"에 대한 코드 샘플
요청 예제
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/audit-log/streams/STREAM_IDThe audit log stream configuration was deleted successfully.
Status: 204