User with the necessary permission can generate an API key from their account settings.

Prerequisites

A user must be assigned a role with the Generate API-Key permission enabled. See Create API key generation role.

Procedure

  1. Log in to the Control Room as the user with the Generate API-Key permission.
  2. Navigate to the user name profile at the bottom left of the page and select username > My settings.
  3. Click Generate API-Key at the top right of the page.
  4. Copy the generated API-Key to your clipboard.

    The API expiration field displays the date and time when the API key expires. Use this information to renew the API key so that you can run your automation seamlessly.

Next steps

  • Use the API-Key to log in to a Control Room using SSO, or use the API-Key to log in as a user without a password.
  • Configure API key duration