Конечные точки 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
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Enterprise administration" business permissions (read)
Параметры для "Get the audit log for an enterprise"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description |
---|
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." По умолчанию.: |
Коды состояния http-ответа для "Get the audit log for an enterprise"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "Get the audit log for an enterprise"
Если вы обращаетесь к GitHub в GHE.com, замените 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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния http-ответа для "Get the audit log stream key for encrypting secrets"
Код состояния | Описание |
---|---|
200 | The stream key for the audit log streaming configuration was retrieved successfully. |
Примеры кода для "Get the audit log stream key for encrypting secrets"
Если вы обращаетесь к GitHub в GHE.com, замените 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.
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния http-ответа для "List audit log stream configurations for an enterprise"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "List audit log stream configurations for an enterprise"
Если вы обращаетесь к GitHub в GHE.com, замените 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
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
Имя., Тип, Description |
---|
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
Имя., Тип, Description |
---|
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
Имя., Тип, Description |
---|
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
Имя., Тип, Description |
---|
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. |
GoogleCloudConfig
object Обязательное полеGoogle Cloud Config for audit log streaming configuration.
Properties of GoogleCloudConfig
Имя., Тип, Description |
---|
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
Имя., Тип, Description |
---|
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. |
Коды состояния http-ответа для "Create an audit log streaming configuration for an enterprise"
Код состояния | Описание |
---|---|
200 | The audit log stream configuration was created successfully. |
Примеры кода для "Create an audit log streaming configuration for an enterprise"
Если вы обращаетесь к GitHub в GHE.com, замените 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.
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
stream_id integer Обязательное полеThe ID of the audit log stream configuration. |
Коды состояния http-ответа для "List one audit log streaming configuration via a stream ID"
Код состояния | Описание |
---|---|
200 | Lists one audit log stream configuration via stream ID. |
Примеры кода для "List one audit log streaming configuration via a stream ID"
Если вы обращаетесь к GitHub в GHE.com, замените 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.
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
stream_id integer Обязательное полеThe ID of the audit log stream configuration. |
Имя., Тип, Description | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
Имя., Тип, Description |
---|
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
Имя., Тип, Description |
---|
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
Имя., Тип, Description |
---|
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
Имя., Тип, Description |
---|
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. |
GoogleCloudConfig
object Обязательное полеGoogle Cloud Config for audit log streaming configuration.
Properties of GoogleCloudConfig
Имя., Тип, Description |
---|
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
Имя., Тип, Description |
---|
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. |
Коды состояния http-ответа для "Update an existing audit log stream configuration"
Код состояния | Описание |
---|---|
200 | Successful update |
422 | Validation error |
Примеры кода для "Update an existing audit log stream configuration"
Если вы обращаетесь к GitHub в GHE.com, замените 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
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"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
stream_id integer Обязательное полеThe ID of the audit log stream configuration. |
Коды состояния http-ответа для "Delete an audit log streaming configuration for an enterprise"
Код состояния | Описание |
---|---|
204 | The audit log stream configuration was deleted successfully. |
Примеры кода для "Delete an audit log streaming configuration for an enterprise"
Если вы обращаетесь к GitHub в GHE.com, замените 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