Skip to main content
Permissions for API Keys
Ethan Finkel avatar
Written by Ethan Finkel
Updated over a month ago

Overview

Users of Standard Metrics can leverage the API, Excel Add-in, and Google Sheets Add-in to access their in-app data off platform. User access and permissions to off platform features mirror those configured for a user in the app. Additionally, Admin users can manage how users utilize off platform features by controlling which users can create API keys, elevating permissions, or de-activating specific keys as needed.

Who can create and see API keys

While Admins, Editors, and Viewers can all create API keys for themselves, only Admin users have the ability to create API keys for other users. Admins also have the ability to see all keys created by any user on the platform and can manage those keys, while non-Admin users can only see keys they have created.

Admin view:

Non-admin view:

By default, custom permission roles cannot create API keys. However, Admins have the ability to change this by checking the “Can create API keys” box in the configure role page.

Configuring an API key with permissions

When creating an API key for another user, Admins have the ability to choose the desired permission level for the key based on a specified user’s permissions. Admins can select from a drop down of users to set the permissions levels the new API key will have. Non-admin users are not able to select from the drop down and can only create keys with their own permission levels.

Permissions enforcement

When a user with limited permissions attempts to make a query, their permissions are checked to ensure they only access information for which they have permissions.

For example, a user has an API key with read access to Company A, edit access to Company B, and no access to Company C. This user will be able to use the Excel Add-in and Google Sheets Add-in to pull data for both Companies A and B, but they will be unable to see anything for Company C.

In the API, the user will be able to view metrics, notes, and other values for Companies A and B but will be unable to see anything for Company C. They will also be able to write new metrics for Company B, which they have edit access for, but not for Companies A or C.

Did this answer your question?