App Registrations

An App Registration is required to establish a trust relationship to enable API integrations, between a supported Ivanti-hosted cloud application and the Ivanti Neurons Platform.

The authentication method used is OAuth 2.0 Client Credentials grant flow, which allows inbound authentication from the registered application.

A unique app registration is required for each application you want to register. Each time you create an app registration, unique authentication settings are generated. These settings will need to be entered in the application you are registering; this validates and creates the trust relationship, completing the registration. To learn more about this, refer to the Help for the application you want to register. The applications that are currently supported can be found in the Create a New registration section.

App Registrations table

To access App Registrations within the Ivanti Neurons Platform, navigate to Admin > App Registrations. All existing app registrations are listed in the table, with the following details:

Application: The name of the registered application.

Description: The description entered when the app registration was created.

Last authenticated: The last time the registered app was authenticated using the client secret. If no date displays, the application has never been authenticated.

Created by: The name of the person that created the app registration.

Created: The date and time when the app registration was created.

Create a New registration

Choose the applicable supported application section for details on how to create a new registration.

Cherwell Service Management (CSM)

This app registration will only work for Cherwell Service Management versions hosted by Ivanti.

Registering with Cherwell Service Management (Ivanti-hosted) is a necessary pre-requisite step for leveraging the Ivanti Neurons Data Services API. This allows you to retrieve information about devices and use this to populate the Cherwell CMDB as part of a one-step automation flow.

Deploying the Neurons for Discovery CMDB mApp Solution (part of the One-Step Action configuration) requires authentication configuration to your Ivanti Neurons tenant. To learn more, see the Ivanti Neurons for Discovery Integration mApp Solution 1.0 documentation.

To complete the Ivanti Neurons side of the configuration, you need to create a new Cherwell Service Management App Registration.

  1. In Ivanti Neurons, navigate to Admin > App Registrations.
  2. Select New registration to open the New app registration panel.
  3. From the drop-down, select Cherwell Service Management.
  4. Click Continue.
  5. In the Cherwell Service Management panel, optionally enter a Description for the registration.
  6. Click Register to generate the authentication settings.
  7. In the Complete this registration panel, the authentication settings, required to complete the registration, are provided:
    • Neurons Auth Url
    • Client ID
    • Client Secret
  8. Copy or record all of the registration settings. You need to enter these settings in Cherwell Service Management to validate the authentication.
    Warning: For security reasons, the Client Secret will not be visible again once you close this panel, so make sure you copy it before clicking Finish and close.
  9. Once you have made a copy of the settings click Finish and close.

Custom App

Using an Ivanti Neurons API requires authentication configuration to your Ivanti Neurons tenant. To learn more, see the Ivanti Neurons API documentation.

To complete the Ivanti Neurons side of the configuration, you need to create a new Custom Action App Registration.

  1. In Ivanti Neurons, navigate to Admin > App Registrations.
  2. Select New registration to open the New app registration panel.
  3. From the drop-down, select Custom App.
  4. Click Continue.
  5. In the Custom App panel, optionally enter a Description for the registration.
  6. Click Register to generate the authentication settings.
  7. In the Complete this registration panel, the authentication settings, required to complete the registration, are provided:
    • Neurons Auth Url
    • Client ID
    • Client secret
  8. Copy or record all of the registration settings. You need to enter these settings in the Get Neurons Token API to validate the authentication.
    Warning: For security reasons, the Client Secret will not be visible again once you close this panel, so make sure you copy it before clicking Finish and close.
  9. Once you have made a copy of the settings click Finish and close.

Ivanti Neurons for ITSM and ITAM (On-Prem)

This app registration is intended to work with on-premise deployments of Ivanti Neurons for ITSM and ITAM.

Registering with Ivanti Neurons for ITSM and ITAM is a necessary pre-requisite step to support key use cases where Ivanti Neurons for ITSM and ITAM needs to interact with the Ivanti Neurons Data Services APIs. Learn more about ITAM and Neurons integration.

To complete the Ivanti Neurons side of the configuration, you need to create a new Ivanti Neurons for ITSM and ITAM (On-Prem) App Registration.

  1. In Ivanti Neurons, navigate to Admin > App Registrations.
  2. Select New registration to open the New app registration panel.
  3. From the drop-down, select Ivanti Neurons for ITSM and ITAM (On-Prem).
  4. Click Continue.
  5. In the Ivanti Neurons for ITSM and ITAM (On-Prem) panel, optionally enter a Description for the registration.
  6. Click Register to generate the authentication settings.
  7. In the Complete this registration panel, the authentication settings, required to complete the registration, are provided:
    • Neurons Auth Url
    • Client ID
  8. Copy or record all of the registration settings. You need to enter these settings in the Get Neurons Token API to validate the authentication.
  9. Once you have made a copy of the settings click Finish and close.

Ivanti User Workspace Manager (On-Prem)

This app registration is intended to work with the on-premise consoles from the Ivanti User Workspace Manager suite.

Registering with Ivanti Neurons is a necessary pre-requisite step to allow the Ivanti User Workspace Manager on-premise consoles (Application Control, Environment Manager, and Performance Manager) to save and deploy configurations within Ivanti Neurons. Learn more about the Ivanti Neurons integration in the relevant User Workspace Manager Help: Application Control, Environment Manager, Performance Manager.

To complete the Ivanti Neurons side of the configuration, you need to create a new User Workspace Manager App Registration.

  1. In Ivanti Neurons, navigate to Admin > App Registrations.
  2. Select New registration to open the New app registration panel.
  3. From the drop-down, select Ivanti User Workspace Manager (On-Prem).
  4. Click Continue.
  5. In the Ivanti User Workspace Manager (On-Prem) panel, optionally enter a Description for the registration.
  6. Click Register to generate the authentication settings.
  7. In the Complete this registration panel, the authentication settings, required to complete the registration, are provided:
    • Neurons Auth Url
    • Client ID
  8. Copy or record all of the registration settings. You need to enter these settings in Ivanti User Workspace Manager to validate the authentication.
  9. Once you have made a copy of the settings click Finish and close.

Ivanti Neurons for Risk-based Vulnerability Management (IN4RBVM) Patch Group Admin

The IN4RBVM Patch Group Admin app registration is for CVEsToPatchGroup, if you are using Ivanti Neurons for Patch Management with Ivanti Neurons for Risk-based Vulnerability Management integration. It will only work with the Neurons Patch Management API on developer.ivanti.com, to learn more see Patch Management API Endpoints authentication.

This app registration grants the caller Neurons for Patch Management Patch Group Admin permissions and is bound to the patchgroup.admin scope. This registration can create new patch groups, and edit existing patch groups.

  1. In Ivanti Neurons, navigate to Admin > App Registrations.
  2. Select New registration to open the New app registration panel.
  3. From the drop-down, select IN4RBVM Patch Group Admin.
  4. Click Continue.
  5. In the IN4RBVM Patch Group Admin panel, optionally enter a Description for the registration.
  6. Click Register to generate the authentication settings.
  7. In the Complete this registration panel, the authentication settings, required to complete the registration, are provided:
    • Neurons Auth Url
    • Client ID
    • Client secret
  8. Copy or record all of the registration settings. You need to enter these settings in the Get Neurons Token API to validate the authentication.
    Warning: For security reasons, the Client Secret will not be visible again once you close this panel, so make sure you copy it before clicking Finish and close.
  9. Once you have made a copy of the settings click Finish and close.

Ivanti Neurons for Risk-based Vulnerability Management (IN4RBVM) Patch Group Editor

The IN4RBVM Patch Group Editor app registration is for CVEsToPatchGroup, if you are using Ivanti Neurons for Patch Management with Ivanti Neurons for Risk-based Vulnerability Management integration. It will only work with the Neurons Patch Management API on developer.ivanti.com, to learn more see Patch Management API Endpoints authentication.

This app registration grants the caller Neurons for Patch Management Patch Group Editor permissions and is bound to the patchgroup.editor scope. This registration can edit patch groups.

  1. In Ivanti Neurons, navigate to Admin > App Registrations.
  2. Select New registration to open the New app registration panel.
  3. From the drop-down, select IN4RBVM Patch Group Editor.
  4. Click Continue.
  5. In the IN4RBVM Patch Group Editor panel, optionally enter a Description for the registration.
  6. Click Register to generate the authentication settings.
  7. In the Complete this registration panel, the authentication settings, required to complete the registration, are provided:
    • Neurons Auth Url
    • Client ID
    • Client secret
  8. Copy or record all of the registration settings. You need to enter these settings in the Get Neurons Token API to validate the authentication.
    Warning: For security reasons, the Client Secret will not be visible again once you close this panel, so make sure you copy it before clicking Finish and close.
  9. Once you have made a copy of the settings click Finish and close.

Delete an App registration

If you need to update the Client Secret or any of the registration details, you must delete the app registration and create a new one.

  1. In Ivanti Neurons, navigate to Admin > App Registrations.
  2. From the App registrations table, select the check box next to the app registration you want to delete.
  3. From the Actions menu, select Delete.
    A confirmation dialog appears.
  4. Select Delete to confirm the action.
    Warning: Deleting an app registration cannot be undone and the application will no longer be able to authenticate with the Ivanti Neurons Platform unless another app registration is created.