Copy an API Key

Copy an API key to provide the API key to the application vendor who requested the key.

You copy the API key to the Clipboard and then paste it into a text document that you provide to the application vendor.

Before you begin 

  • Display the API Key value in the user interface by clicking the Show the key value icon Show the key value icon in the Actions column. Clicking this icon also enables the copy icon Copy icon .

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 copy an Internal API Key.

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

The Generate Internal API Key and Generate External API Key user security privileges are not assigned by default. Assign these privileges to a user security role only if you need to generate an API key and the Text Analyitcs feature is not deployed in your enterprise. 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. In the Actions column for the key you want to copy, click the Copy icon icon. (Move your mouse over the Actions column to make the icon display.)

    You can now paste the key into a text document.

Using API Keys when automating tasks

Display an API Key value

Generate an API Key