Skip to main content

API keys

An API key enables an application to interact with Uniform in order to read and write settings. This section describes how to create, edit and delete API keys. It also describes the permissions that can be assigned to an API key.

tip

Examples of applications that require an API key are:

info

Only team admins can create, edit and delete API keys.

Create API key

  1. In Uniform, navigate to Security > API Keys.

  2. Click the red (+) button.

  3. Enter a value for the field Name.

    caution

    You cannot change the name after you create the API key.

  4. Assign permissions to the project(s) you want the API key to have access to. The following options are supported:

  5. Click Create API Key.

  6. The following values are displayed:

    ValueDescription
    KeyThis is the API key.
    Project IDWhen an API key is used, it is used to interact with a specific project. Whenever you use an API key, you also need to identify which project you want to interact with by specifying its project ID. Uniform displays the project ID here so you don't have to go looking for it.
    Quick ConnectIn order to interact with Uniform using an API key, you actually need 3 values: the API key, the project ID, and the Uniform application endpoint. This value provides all 3 of these in a single string. This makes it easier for you to configure connections to Uniform from other systems.
    caution

    This is the only time the API key and Quick Connect values are displayed. Before you move on to the next step, you must save these values somewhere so you can use them in the future.

  7. Click Close.

Delete API key

caution

Deleting an API key is a permanent operation. While you can create a new API key with the same settings, you will never get the same key value again.

  1. In Uniform, navigate to Security > API Keys.
  2. Click the name of the API key you want to delete.
  3. Click delete.
  4. Click OK.

Assign permissions

An API key provides access to Uniform projects. The permissions are configured separately for each project the API key has access to. You can change the projects assigned to an API key and the permissions assigned to each project at any time.

Change roles

An API key can have multiple roles assigned. If the selected roles have conflicting permissions, the permission is allowed. For example, if one role has the delete composition permission disabled and another role has it enabled, selecting both roles results in the permission being enabled.

  1. In Uniform, navigate to Security > API Keys.

  2. Click the name of the API key you want to modify.

  3. In the row for the project, use the dropdown to select the roles you want to assign.

    info

    If the dropdown is not available, custom permissions are assigned. You must disable custom permissions before you can assign roles.

Enable custom permissions

Custom permissions allow you to assign permissions directly to a project.

  1. In Uniform, navigate to Security > API Keys.

  2. Click the name of the API key you want to modify.

  3. In the row for the project, click ... > Use Custom Permissions.

    info

    If this option is not available, custom permissions are already enabled.

  4. Click edit.

  5. Select the permissions you want to assign to the API key.

  6. Click Use Custom Permissions.

  7. Click Save.

Disable custom permissions

You can disable custom permissions on a project. When custom permissions are disabled, you select permissions by selecting a role. When a role is selected, the API key inherits the permissions assigned to the role.

  1. In Uniform, navigate to Security > API Keys.

  2. Click the name of the API key you want to modify.

  3. In the row for the project, click ... > Remove Custom Permissions.

    info

    If this option is not available, custom permissions are not enabled.

  4. Click Remove Custom Permissions.

  5. Click Save.