Documentation Center
AlienVault® USM Anywhere™

USM Anywhere API

  Role Availability   Read-Only   Analyst   Manager

USM Anywhere offers a REST API framework that allows you to customize elements of data in your environment. The AlienVault APIs return JSON responses with errors that use HTTP response codes. To access the API, you will need to create a client ID and secret code in the USM Anywhere interface, and use that information to create a token. AlienVault uses OAuth 2.0 to authenticate against the REST APIs.

Client ID and Secret Code Management

To get your client ID and secret code

  1. Click the icon and select Profile.
  2. On the Profile page, select the API Clients tab.
  3. Click New Client.
  4. Name the Client and click Create Client.
  5. The system generates the secret code.

    Important: This code will only be available when it is first generated, so be sure to keep it secure and copy it when it is displayed.

To reset your secret

  1. Click the icon and select Profile.
  2. On the Profile page, select the API Clients tab.
  3. Click the Reset Secret link.
  4. The Reset Secret window is displayed. Click Reset Secret to confirm you want to proceed.
  5. The success page is displayed and shows the new secret code.

    Important: This code will only be available when it is first generated, so be sure to keep it secure and copy it when it is displayed.

To delete an API client

  1. Click the icon and select Profile.
  2. On the Profile page, select the API Clients tab.
  3. The Delete Client message is displayed. Click Delete Client to confirm you want to proceed.

Token Generation with OAuth 2.0

AlienVault uses the OAuth 2.0 standard for token endpoint security, with the username and password being the client ID that USM Anywhere generates. The token that is generated by USM Anywhere will expire after fifteen minutes, which means you will have to reauthenticate to get a new token after its expiry.

More information about authentication using OAuth 2.0 can be found on the AlienVault API page.

API Framework

For information about accessing and using the AlienVault API frameworks, see the AlienVault API page.