API Token Authentication

If you are having issues passing an authentication token for API calls, please reference this article. For general questions related to the API or the Swagger UI, please contact Support.

Token-based authentication (or, OAuth) is used in place of "basic auth" in which you pass along the username and password in the headers. OAuth is strongly encouraged for users who frequently utilize the API as it is more secure and less exposed, containing no user information or distinguishing identifiers.

Finding your auth token:

Navigate to FireMon's Administration page. Once here, click on "API Reference" to be taken to the Swagger UI. Once this page loads, expand out "authentication" and choose "POST /authentication/login". Fill out the body as such with your actual user information:

{
  "username": "string",
  "password": "string"  
}

Once filled in, click the "Try it out!" button to execute the API call (please note, you may receive a pop-up asking you to sign in again using your web UI credentials). In the "Curl" field below the body, you will see part of the auth token, however, this is not the full token. Scroll down a little further to the "Response Body" section and you will see the full token and its TTL:

​
This is the token that you will need to use in your header.

Using the auth token:

To successfully pass the auth token in place of basic auth, please formulate your header to match the example below, substituting your auth token from your API call in place of the example:

-H "X-FM-Auth-Token: ZmlyZW1vbg;2018-12-06_18:18:26.134+0000;8601b6cd-62c5-4ce6-a2ac-f2cd289ec21b"

Auth tokens by default are valid for 180 minutes after which point you will need to generate a new token. If you have validated your token is correct using this article and are still receiving errors when attempting to pass this, please contact Support for further assistance.