Generating and managing API keys

Starting in 8.11, generate and manage application programming interface (API) keys to use in automation processes for user management in IBM® Maximo® Application Suite.

About this task

As a suite administrator, you can create, edit, or delete API keys in Maximo Application Suite. You can activate, deactivate, or refresh authentication tokens for the API keys. The API keys are used in user management for automation processes.

Log in to Maximo Application Suite as an administrator user.

Procedure

In IBM Maximo Application Suite, from the side navigation menu, select API keys.
  • Create an API key.
    1. On the API keys page, click Create API key.
    2. On the Create API key page, enter the following details:
      Description
      Text that provides context about the API key, such as the purpose of the API key.
      Authentication token expiry
      The number of days or provide custom days for the authentication token to expire. This token can be used for the duration that the authentication token for the API key is valid before you need to refresh. The token is automatically inactive and no longer available to use after the expiration date.
    3. Select the suite administrative privileges, such as System configuration or User management, that are applicable to the API key.
    4. Click Submit.
      Tip: Copy the authentication token details. If authentication token details are lost, you cannot recover the details. To create a token, you must create an API key.
    5. Verify that the key is saved and available in the list of API keys.
  • Edit an API key.
    1. On the API keys page, select the API key that you need to edit.
    2. From the More actions icon, select Edit.

      Alternatively, you can edit the API key after you open an API key to view the key details.

    3. On the Edit API key page, change details, such as the description, authentication token expiry duration, and administrative privileges.
    4. Click Submit.
    5. Verify that the key is saved and available in the list of API keys.
  • Delete an API key.
    1. On the API keys page, select a single key or multiple keys to delete.
    2. Click Delete.
    3. In the Confirm delete API key dialog, click Delete.
    4. Verify that the key or keys are removed from the list of API keys.
  • Activate an API key.
    1. On the API keys page, select a single key or multiple keys.
    2. Click Activate.
    3. In the list of API keys, verify that the status of the API key changes to active.
  • Deactivate an API key.
    1. On the API keys page, a select single key or multiple keys.
    2. Click Dectivate.
    3. In the list of API keys, verify that the status of the API key changes to inactive.
  • Refresh an authentication token.
    1. Select a single key or multiple keys and click Refresh authentication token.
    2. In the Confirm refresh authentication tokens dialog, click Confirm.

      When you refresh the authentication tokens for the API keys, new tokens are generated, and the current tokens expire.