How to Authenticate to the Neurons API

Create an App Registration

When you first use the API, you need to create an App Registration in the Ivanti Neurons console. For more information, see Custom App.

Log in to the Neurons API

  1. Browse to the Ivanti Developer Hub.
  2. Click on the required API (For example - Patch Management, People and Devices, and Neurons Bots) in the Ivanti Neurons collection.
  3. In the drop-down at the top of the page, select the landscape your tenant is on.

    4. The required landscape largely depends on where your organization is based and where you want your data stored. Select the appropriate value from this table, and if you get an error at the end of this procedure, contact Ivanti support who can help you to determine the correct value.

    Location Landscape

    Americas

    nvu

    Customers who requested data to be stored in the European Union

    fru

    Europe, Middle-East or Africa (EMEA)

    uku

    Asia Pacific, Australia

    mlu

  4. Expand the authentication endpoint and click Authentication_Get.
  5. Provide values for the ClientSecret, TenantId and ClientId parameters.
    These are the values you saved in the previous section.
  6. Click Test Endpoint.
  7. In the response, note the value in the access-token field.

In all future calls using the other endpoints, add Bearer <access-token value> to the Authorization parameter field. For example, if the returned token is abcdefg, then add Bearer abcdefg to the Authorization field.

The token contains an expiration time. When the token expires, you will need to repeat the Authentication_Get call to get a fresh token.