API Tokens#

Overview#

API tokens can be used authenticate accounts (both local Nucleus and Single Sign-On accounts) from automated clients and systems that cannot log in interactively (e.g., batch processing, IoT robots, etc.)

API Tokens are generated using Nucleus Navigator. When generating a token, it is only visible during creation time (due to security), however it can be deleted (and re-created, if necessary), at any time.

Token Generation#

  1. Within Nucleus Navigator, right-click the Nucleus Server where you want to create the token, then click API Tokens from the menu:

API Tokens

  1. The API Tokens window will display as shown:

Create API tokens

  1. Specify a unique name for the token and enter it into the Token Name field, then click Create.

  2. The token will be displayed in the window:

Create active API token

  1. Click Copy to copy the generated token to your workstation’s clipboard.

Warning

Do not close the API Tokens dialog window until you have copied the token as once the window is closed, it cannot be retrieved.

Using an API Token#

To use an API token to authenticate with Nucleus, the following options are available:

Option 1: Logging in interactively: (Entering a username and password into the authentication dialog window.)

  • Use $omni-api-token (specify the string exactly as written including the leading dollar sign) as the username

  • Use the generated API token as the password

Option 2: Using client environment variables: (Supported on both Microsoft Windows and Linux.)

  • Variable: OMNI_USER, Value: $omni-api-token (specify the string exactly as written including the leading dollar sign) as the username

  • Variable: OMNI_PASS, Value: Use the generated API token as the password

On this page