엔터프라이즈 감사 로그에 대한 REST API 엔드포인트
REST API를 사용하여 엔터프라이즈에 대한 감사 로그를 검색합니다.
이러한 엔드포인트는 personal access token (classic)을(를) 사용하는 인증만 지원합니다. 자세한 내용은 "개인용 액세스 토큰 관리"을(를) 참조하세요.
Get the audit log for an enterprise
Gets the audit log for an enterprise.
This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "Rate limits for the REST API" and "Best practices for integrators."
The authenticated user must be an enterprise admin to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the read:audit_log
scope to use this endpoint.
"Get the audit log for an enterprise"에 대한 세분화된 액세스 토큰
이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:
세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:
- "Enterprise administration" business permissions (read)
"Get the audit log for an enterprise"에 대한 매개 변수
속성, 형식, 설명 |
---|
accept string Setting to |
속성, 형식, 설명 |
---|
enterprise string RequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
속성, 형식, 설명 |
---|
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"에 대한 코드 샘플
GHE.com에서 GitHub에 액세스하는 경우 api.github.com
을 api.SUBDOMAIN.ghe.com
의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/audit-log
Response
Status: 200
[
{
"@timestamp": 1606929874512,
"action": "team.add_member",
"actor": "octocat",
"created_at": 1606929874512,
"_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw",
"org": "octo-corp",
"team": "octo-corp/example-team",
"user": "monalisa"
},
{
"@timestamp": 1606507117008,
"action": "org.create",
"actor": "octocat",
"created_at": 1606507117008,
"_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ",
"org": "octocat-test-org"
},
{
"@timestamp": 1605719148837,
"action": "repo.destroy",
"actor": "monalisa",
"created_at": 1605719148837,
"_document_id": "LwW2vpJZCDS-WUmo9Z-ifw",
"org": "mona-org",
"repo": "mona-org/mona-test-repo",
"visibility": "private"
}
]
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 RequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
"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"에 대한 코드 샘플
GHE.com에서 GitHub에 액세스하는 경우 api.github.com
을 api.SUBDOMAIN.ghe.com
의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/audit-log/stream-key
The stream key for the audit log streaming configuration was retrieved successfully.
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 RequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
"List audit log stream configurations for an enterprise"에 대한 HTTP 응답 상태 코드
상태 코드 | 설명 |
---|---|
200 | OK |
"List audit log stream configurations for an enterprise"에 대한 코드 샘플
GHE.com에서 GitHub에 액세스하는 경우 api.github.com
을 api.SUBDOMAIN.ghe.com
의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/audit-log/streams
OK
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 RequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
속성, 형식, 설명 | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
enabled boolean RequiredThis setting pauses or resumes a stream. | |||||||||||||||||||||||||||||||||||||||||||||||||
stream_type string RequiredThe audit log streaming provider. The name is case sensitive. 다음 중 하나일 수 있습니다.: | |||||||||||||||||||||||||||||||||||||||||||||||||
vendor_specific object Required | |||||||||||||||||||||||||||||||||||||||||||||||||
Can be one of these objects:
AzureHubConfig object RequiredAzure Event Hubs Config for audit log streaming configuration. Properties of |
속성, 형식, 설명 |
---|
name string RequiredInstance name of Azure Event Hubs |
encrypted_connstring string RequiredEncrypted Connection String for Azure Event Hubs |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
AmazonS3OIDCConfig
object RequiredAmazon S3 OIDC Config for audit log streaming configuration.
Properties of AmazonS3OIDCConfig
속성, 형식, 설명 |
---|
bucket string RequiredAmazon S3 Bucket Name. |
region string RequiredAWS S3 Bucket Region. |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
authentication_type string RequiredAuthentication Type for Amazon S3. 값: |
arn_role string Required |
AmazonS3AccessKeysConfig
object RequiredAmazon S3 Access Keys Config for audit log streaming configuration.
Properties of AmazonS3AccessKeysConfig
속성, 형식, 설명 |
---|
bucket string RequiredAmazon S3 Bucket Name. |
region string RequiredAmazon S3 Bucket Name. |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
authentication_type string RequiredAuthentication Type for Amazon S3. 값: |
encrypted_secret_key string RequiredEncrypted AWS Secret Key. |
encrypted_access_key_id string RequiredEncrypted AWS Access Key ID. |
SplunkConfig
object RequiredSplunk Config for Audit Log Stream Configuration
Properties of SplunkConfig
속성, 형식, 설명 |
---|
domain string RequiredDomain of Splunk instance. |
port integer RequiredThe port number for connecting to Splunk. |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_token string RequiredEncrypted Token. |
ssl_verify boolean RequiredSSL verification helps ensure your events are sent to your Splunk endpoint securely. |
GoogleCloudConfig
object RequiredGoogle Cloud Config for audit log streaming configuration.
Properties of GoogleCloudConfig
속성, 형식, 설명 |
---|
bucket string RequiredGoogle Cloud Bucket Name |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_json_credentials string Required |
DatadogConfig
object RequiredDatadog Config for audit log streaming configuration.
Properties of DatadogConfig
속성, 형식, 설명 |
---|
encrypted_token string RequiredEncrypted Splunk token. |
site string RequiredDatadog Site to use. 다음 중 하나일 수 있습니다.: |
key_id string RequiredKey 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"에 대한 코드 샘플
GHE.com에서 GitHub에 액세스하는 경우 api.github.com
을 api.SUBDOMAIN.ghe.com
의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.
요청 예제
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/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.
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 RequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
stream_id integer RequiredThe 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"에 대한 코드 샘플
GHE.com에서 GitHub에 액세스하는 경우 api.github.com
을 api.SUBDOMAIN.ghe.com
의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/audit-log/streams/STREAM_ID
Lists one audit log stream configuration via stream ID.
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 RequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
stream_id integer RequiredThe ID of the audit log stream configuration. |
속성, 형식, 설명 | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
enabled boolean RequiredThis setting pauses or resumes a stream. | |||||||||||||||||||||||||||||||||||||||||||||||||
stream_type string RequiredThe audit log streaming provider. The name is case sensitive. 다음 중 하나일 수 있습니다.: | |||||||||||||||||||||||||||||||||||||||||||||||||
vendor_specific object Required | |||||||||||||||||||||||||||||||||||||||||||||||||
Can be one of these objects:
AzureHubConfig object RequiredAzure Event Hubs Config for audit log streaming configuration. Properties of |
속성, 형식, 설명 |
---|
name string RequiredInstance name of Azure Event Hubs |
encrypted_connstring string RequiredEncrypted Connection String for Azure Event Hubs |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
AmazonS3OIDCConfig
object RequiredAmazon S3 OIDC Config for audit log streaming configuration.
Properties of AmazonS3OIDCConfig
속성, 형식, 설명 |
---|
bucket string RequiredAmazon S3 Bucket Name. |
region string RequiredAWS S3 Bucket Region. |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
authentication_type string RequiredAuthentication Type for Amazon S3. 값: |
arn_role string Required |
AmazonS3AccessKeysConfig
object RequiredAmazon S3 Access Keys Config for audit log streaming configuration.
Properties of AmazonS3AccessKeysConfig
속성, 형식, 설명 |
---|
bucket string RequiredAmazon S3 Bucket Name. |
region string RequiredAmazon S3 Bucket Name. |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
authentication_type string RequiredAuthentication Type for Amazon S3. 값: |
encrypted_secret_key string RequiredEncrypted AWS Secret Key. |
encrypted_access_key_id string RequiredEncrypted AWS Access Key ID. |
SplunkConfig
object RequiredSplunk Config for Audit Log Stream Configuration
Properties of SplunkConfig
속성, 형식, 설명 |
---|
domain string RequiredDomain of Splunk instance. |
port integer RequiredThe port number for connecting to Splunk. |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_token string RequiredEncrypted Token. |
ssl_verify boolean RequiredSSL verification helps ensure your events are sent to your Splunk endpoint securely. |
GoogleCloudConfig
object RequiredGoogle Cloud Config for audit log streaming configuration.
Properties of GoogleCloudConfig
속성, 형식, 설명 |
---|
bucket string RequiredGoogle Cloud Bucket Name |
key_id string RequiredKey ID obtained from the audit log stream key endpoint used to encrypt secrets. |
encrypted_json_credentials string Required |
DatadogConfig
object RequiredDatadog Config for audit log streaming configuration.
Properties of DatadogConfig
속성, 형식, 설명 |
---|
encrypted_token string RequiredEncrypted Splunk token. |
site string RequiredDatadog Site to use. 다음 중 하나일 수 있습니다.: |
key_id string RequiredKey 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"에 대한 코드 샘플
GHE.com에서 GitHub에 액세스하는 경우 api.github.com
을 api.SUBDOMAIN.ghe.com
의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.
요청 예제
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/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
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 RequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
stream_id integer RequiredThe 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"에 대한 코드 샘플
GHE.com에서 GitHub에 액세스하는 경우 api.github.com
을 api.SUBDOMAIN.ghe.com
의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.
요청 예제
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/audit-log/streams/STREAM_ID
The audit log stream configuration was deleted successfully.
Status: 204