Managing API keys

Generate API credentials your organization can use to work with the public Cloud Identity Portal API.

About this task

Create, edit, and remove API keys.

Procedure

  1. In the navigation pane, click Company Profile > API Key Management.
  2. Manage your API keys.
    Add a REST API key
    1. Click + Add New API Key.
    2. Specify the following fields:
      Table 1. API key fields
      Field Description
      Key Alias Create an alternate name for the API key with fifty alphanumeric characters or less that is easy to identify.
      Key Description Describe what the key is used for and where it is.
      Access Token Validity Specify for how many seconds this token is valid. The approximate number of hours or days for the value that you entered is shown next to this field. You obtain an access token after you send the client ID, secret, and grant_type to the URL POST https://GmaApi/oauth/token. Use this access token to make calls to the API.
      Note: The secret key will display once after you create your new API key. Once you save the changes for your new API key, the secret key will never display again.
      After the access token expires, obtain a new one with the client ID, secret, and grant_type. Alternatively, you can obtain a new access token by using the refresh token and the client ID and secret.
      Refresh Token Validity Specify the number of seconds for the Refresh Token Validity time, which must be greater than the Access Token Validity value. The approximate number of hours or days for the value that you entered is shown next to this field.
    Edit or delete a REST API key
    1. View the details of the API key that you want to edit or delete by searching in the Narrow your search bar or by clicking the arrow next to the key name.
    2. Select the API key name that you want to edit or delete.
    3. Take either of the following actions:
      • Edit and change the values for any of those described in Table 1.
      • Click Remove Key to permanently delete the key.