Create, copy and revoke an API key

Steps

1. 1

   Open Organisation settings and select API keys and audit log

   Open the menu under your initial, select Organisation settings, then select API keys and audit log in the settings menu. This section used to be called Integrations. It was renamed so it is not confused with the accounting connectors.

   • Select Account menu
   • Select Organisation settings
   • Select API keys & audit log
2. 2

   Select Manage API Keys

   The section has two cards. API Access leads to the keys, and Audit Log leads to the full history of actions. Select Manage API Keys. The API Keys page lists the active keys, or says that none exist yet.

   • Select Manage API Keys →
3. 3

   Select Create Key

   Select Create Key at the top right. The Create API Key window opens.

   • Select Create Key
4. 4

   Name the key after the system that will use it

   In Name, type which system uses the key and what for. The name is required. A clear name tells you later which key to revoke.

   • Type Name *: Power BI compliance dashboard (read only)
5. 5

   Tick the role the key needs

   Under Roles there are three choices. Viewer reads compliance data. Editor reads and writes. Auditor reads, with the audit trail. Tick Viewer. The note below explains that a key can only carry permissions you hold yourself, over the entities it covers.

   • Select Viewer
6. 6

   Limit the key to one entity

   Under Entity Access tick Meridian Souq Trading LLC. The key can then reach only that entity. If you tick nothing, the key can reach every entity.

   • Select Meridian Souq Trading LLC

   

7. 7

   Set an expiry date

   In Expiry Date choose the day the key should stop working, here about three months ahead. The field is optional. Leaving it empty means the key never expires.

   • Type Expiry Date (optional): 2027-01-12
8. 8

   Select Create Key

   Select Create Key at the bottom of the window. A second window, API Key Created, shows the full key. This is the only time it is shown.

   • Select Create Key
9. 9

   Copy the key, then select Done

   Select Copy and paste the key straight into the other system or your company's password manager. Then select Done. The key is listed with the first characters of its code, its role, the number of entities it can reach, the status Active, when it was last used and when it expires.

   • Select Done
10. 10

    Select Revoke on the key

    When the other system stops using the key, or you think the key has leaked, select Revoke on its line. A warning explains that this is permanent and that anything using the key loses access immediately.

    • Select Revoke
11. 11

    Select Revoke Key

    Select Revoke Key. The key stops working at once and leaves the list. With no other key, the page reads No active API keys and says how many revoked keys are hidden.

    • Select Revoke Key
12. 12

    Switch on Show revoked

    Switch on Show revoked above the list. Revoked keys come back, greyed out and marked Revoked, with no Revoke button. They are kept as a record that the key existed and who created it.