Skip to main content

Manage API tokens

Use Token Management to create, revoke and delete API tokens. An API token gives an application or script programmatic access to ScoutIT AI.

Before you start​

  • You need the Administrator user permission.
  • Treat every token like a password. Anyone who has it can use it.

Open Token Management​

  1. Select the apps button in the top bar, then select Admin.
  2. Select Tokens.

You can also open it from Admin IT → Token Management in the navigation.

Create a token​

  1. Select Create Token. The Create API Token dialog opens.
  2. In Token Name, enter a name that says what the token is for.
  3. Optional: in Description, add more detail.
  4. Under Expiration, choose 30 days, 90 days, 180 days, 365 days or Never. 90 days is selected by default.
  5. Select Create Token.

What happens next​

The Token Created dialog shows the new token.

  1. Select Copy to copy the token.
  2. Store it somewhere secure, such as a password manager.
  3. Select Done.
warning

You can see the token only once. After you select Done, it can't be shown again. If you lose it, create a new token and revoke the old one.

Read the token list​

ColumnWhat it shows
Token NameThe name you gave the token.
DescriptionThe description, if you added one.
StatusActive, Expiring Soon (expires within 15 days) or Revoked.
CreatedThe date the token was created.
ExpiresThe expiry date, or Never.
Last UsedThe date the token was last used, or Never.

To find a token, type in Search tokens.... To show only some tokens, choose All Status, Active or Revoked from the status list.

Revoke a token​

Revoke a token to stop it working while keeping it in the list.

  1. Find the token and select the Revoke token button in its row.
  2. In the Revoke Token dialog, select Revoke Token.

The token stops working immediately. Any application or service that uses it loses access. Its status changes to Revoked.

Delete a token​

Deleting a token removes it permanently. This can't be undone.

  1. Find the token and select the Delete token button in its row.
  2. In the Delete Token dialog, type DELETE in the box.
  3. Select Delete Token.

Troubleshooting​

MessageWhat to do
Token name is required.Enter a Token Name.
Type DELETE to confirm.Type DELETE in capital letters, exactly as shown.
Action failed. Please try again.Try again. If it keeps failing, contact support.
A token shows Expiring SoonCreate a replacement token, update the application that uses it, then revoke the old token.