Skip to main content

Manage 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:

  • Uniform CLI
  • Contentful app
  • Contentstack Marketplace app
info

Only team administrators can create, edit and delete API keys. For more information on users and user types, see the Users section.

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. Find the project you want the API key to have access to and assign roles.

    info

    You can assign multiple roles, permissions within the roles are additive for the API key.

  5. Optionally you can select custom permissions you want to assign by selecting ... and Use Custom Permissions.

    About this step

    See the permissions section for details about the individual permissions that are supported.

    Once permissions are decided click Use Custom Permissions to apply them to the API key.

  6. Click Create API Key.

  7. 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.

  8. 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.

Add project assignment​

Each API key is assigned to one or more projects. Additional projects can be assigned to an API key at any time.

  1. In Uniform, navigate to Security > API Keys.
  2. Click the name of the API key you want to modify.
  3. Find the project you want to add and click Add to project.
  4. Select the permissions you want to assign and click Set Permissions.
  5. Click Save.

Remove project assignment​

Each API key is assigned to one or more projects. Projects can be removed from an API key at any time.

  1. In Uniform, navigate to Security > API Keys.
  2. Click the name of the API key you want to modify.
  3. Find the project you want to add and click edit.
  4. Click Remove From Project.
  5. Click Save.

Change permissions​

You can change permissions on an API key at any time.

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

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

  3. Find the project you want the API key to have access to and assign roles.

    info

    You can assign multiple roles, permissions within the roles are additive for the API key.

  4. Optionally you can select custom permissions you want to assign by selecting ... and Use Custom Permissions.

    About this step

    See the permissions section for details about the individual permissions that are supported.

    Once permissions are decided click Use Custom Permissions to apply them to the API key.

  5. Click Save.