From 31aa80e5e9966f79f44530982425b8bb58c0f43f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia=20Carpinteiro?= Date: Thu, 20 Jun 2024 10:26:02 +0100 Subject: [PATCH] clean: Improved required role admonition --- .../obtaining-audit-log-events-for-organization.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/codacy-api/examples/obtaining-audit-log-events-for-organization.md b/docs/codacy-api/examples/obtaining-audit-log-events-for-organization.md index 120df16e41..8e8d91025f 100644 --- a/docs/codacy-api/examples/obtaining-audit-log-events-for-organization.md +++ b/docs/codacy-api/examples/obtaining-audit-log-events-for-organization.md @@ -14,12 +14,13 @@ For example, you may want to generate an audit log report for your organization, This example exports the actor, action, timestamp, result, source, repository name, and details in CSV format for [all tracked events](../../organizations/audit-logs-for-organizations.md) of your organization. -!!! important - The user authenticating on the Codacy API must be an organization admin or organization manager. - The example script: 1. Defines the [account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API. + + !!! note + The user authenticating on the Codacy API must be an [organization admin or organization manager](../../organizations/roles-and-permissions-for-organizations.md). + 1. Calls the endpoint [listAuditLogsForOrganization](https://api.codacy.com/api/api-docs#codacy-api-organization) to retrieve the audit log events for your organization. 1. Uses [jq](https://github.com/stedolan/jq) to select only the necessary data fields and convert the results to the CSV format.