Cherwell

The Cherwell connector allows you to connect to your Cherwell environment to retrieve ITSM tickets, CMDB inventory and user information via OAuth2 API.

Objective

The Cherwell connector allows you to retrieve the following information:

• ITSM tickets (incidents, requests, changes)
• CMDB assets (equipment, configurations)
• Users and groups

Prerequisites

• Access to Cherwell with administrator rights
• OAuth2 API access enabled
• API credentials (Client ID and Client Secret) configured

Authentication

This connector uses OAuth2 (Client ID + Client Secret) for API authentication.

Procedure

Generate OAuth2 Credentials

1. Access Cherwell (Ivanti CSM):
   • Log in to your Cherwell environment with administrator rights.
2. Navigate to REST API Configuration:
   • Go to CSM Administrator > Security > Edit REST API client settings.
3. Create a REST API Client:
   • Click the + button to add a new client.
   • Enter a name for the API client.
   • Configure OAuth2 with Client ID.
   • Note the Client ID and Client Secret generated.
4. Store Credentials:
   • Copy the Client ID and Client Secret securely.
   • You will also need your CSM username and CSM password for authentication.

Configure in OverSOC

1. In OverSOC, go to Data Sources Settings > Sources.
2. Select Cherwell and click Configure.
3. Fill in the required fields:
   • Client ID: Your REST API Client ID
   • CSM Username: Your Cherwell administrator username
   • CSM Password: Your Cherwell administrator password
4. Click Save Configuration.

Official Documentation

For more information, see the Ivanti Cherwell REST API documentation