Document the read:audit_log scope (#32470)

Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
This commit is contained in:
Sarah Edwards 2022-11-14 14:10:50 -08:00 коммит произвёл GitHub
Родитель 97a79cab84
Коммит 5e94dcb229
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 10 добавлений и 3 удалений

Просмотреть файл

@ -18,7 +18,7 @@ topics:
## Using the audit log API
You can interact with the audit log using the GraphQL API or the REST API.
You can interact with the audit log using the GraphQL API or the REST API.{% ifversion read-audit-scope %} You can use the `read:audit_log` scope to access the audit log via the APIs.{% endif %}
Timestamps and date fields in the API response are measured in [UTC epoch milliseconds](http://en.wikipedia.org/wiki/Unix_time).

Просмотреть файл

@ -80,7 +80,8 @@ Name | Description
**`admin:enterprise`** | Gives full control of enterprise functionality. For more information, see "[Managing enterprise accounts](/graphql/guides/managing-enterprise-accounts)" in the GraphQL API documentation.<br><br>Includes `manage_runners:enterprise`{% ifversion ghec or ghes > 3.3 %}, `manage_billing:enterprise`,{% endif %} and `read:enterprise`.
&emsp;`manage_runners:enterprise` | Gives full control over self-hosted runners within the enterprise. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)." {% ifversion ghec or ghes > 3.3 %}
&emsp;`manage_billing:enterprise` | Read and write enterprise billing data. For more information, see "[Billing](/rest/billing)" in the REST API documentation. {% endif %}
&emsp;`read:enterprise` | Read all data on an enterprise profile. Does not include profile data of enterprise members or organizations.{% endif %}
&emsp;`read:enterprise` | Read all data on an enterprise profile. Does not include profile data of enterprise members or organizations.{% endif %}{% ifversion read-audit-scope %}
**`read:audit_log`** | Read audit log data.{% endif %}
{% note %}
**Note:** Your OAuth App can request the scopes in the initial redirection. You

Просмотреть файл

@ -144,7 +144,7 @@ Organizations that use {% data variables.product.prodname_ghe_cloud %} can inter
{% else %}
You can interact with the audit log using the GraphQL API{% ifversion fpt or ghec %} or the REST API{% endif %}.
You can interact with the audit log using the GraphQL API{% ifversion fpt or ghec %} or the REST API{% endif %}.{% ifversion read-audit-scope %} You can use the `read:audit_log` scope to access the audit log via the APIs.{% endif %}
{% ifversion ghec %}

Просмотреть файл

@ -0,0 +1,6 @@
# Issue 8432
# read:audit_log scope
versions:
ghec: '*'
ghes: '>=3.8'
ghae: '>= 3.8'