System Key Management

IMPORTANT: You need to have the Account Administrator role to manage system keys.

System API Keys allow you to centrally manage API keys, giving you the ability to audit and govern usage of them with your account.

TIP: You also can manage system keys using Fivetran REST API.

Create system key

Prerequisites

You need to create a JSON file defining the permissions to be used for your system key.

The following example illustrates the format of the permissions JSON file:

[
    {
        "resource_type": "USER",
        "access_level": "READ"
    },
    {
        "resource_type": "CONNECTOR",
        "access_level": "READ",
        "resource_filter": {
            "ids": [
                "precedence_walnut"
            ],
            "group_ids": [
                "forgiven_greatly"
            ]
        }
    }
]

Instructions

To create a system key in your Fivetran dashboard, do the following:

Go to Account Settings > General > System Keys.
Click +Add system key.
Enter the System key name.
Upload your permissions JSON file. The permissions are displayed in the System key json field.
Click Save. The System key created popup is displayed.
Make a note of the System Key and System Key Secret and store them in your relevant key management system.
Click Done.

Rotate system key

To rotate a system key in your Fivetran dashboard, do the following:

Go to Account Settings > General > System Keys.
Click the key you want to rotate.
Click Actions.
Click Rotate.
Type 'ROTATE' in the confirmation window.
Click Rotate.
The Your secret has been rotated! popup is displayed.
Make a note of the System Key and System Key Secret and store them in your relevant key management system.
Click Done.

Delete system key

To delete a system key in your Fivetran dashboard, do the following:

Go to Account Settings > General > System Keys.
Click the key you want to delete.
Click Actions.
Click Delete.
Type 'DELETE' in the confirmation window.
Click Delete.