Generate an API Key

Generate an API key for an application vendor who requests a key. When you generate a key, it is automatically enabled, making it available for use.

There is a system limit of 300 keys. In a multi-tenant environment, the total number of keys that can be generated for all tenants is 300.

Before you begin 

User security privileges related to API keys are found under the Framework, API Keys, View API Keys privilege Permissions associated with each role that define the features of the application a user is able to view and the functionality in the application the user can access. in the Roles Setup page. You must have the:

  • Generate Internal API Key privilege to generate an Internal API Key.

  • Generate External API Key privilege to generate an External API Key.

If the Text Analytics feature is deployed, you cannot generate API keys.

Procedure 

  1. Go to System Management Module that allows performing suite-wide system management activities from a single, Web-based application, the Enterprise Manager.. Under License Management, select API Keys.

  2. Click the Add an API key icon icon.

  3. Complete the fields on the screen:

    1. Key type: Select either External or Internal.

    2. Description: Type a description of the key. For example: "Created for Face-to-Face recording."

  4. Click Generate.

Related topics 

Generate Key screen reference

Using API Keys when automating tasks

Display an API Key value

Copy an API Key

Disable or enable an API key