Ivanti Neurons ITSM
App Vendor: Ivanti
App Category: IT Service Management
Connector Version: 1.1.1
API Version: 1.0.0
About App
Ivanti Neurons is a flexible and complete cloud-optimized ITSM solution that helps your IT team resolve support issues by automating processes. Automated workflows eliminate costly manual processes while making your business more efficient, compliant, and secure. Whether you’re looking for an IT help desk/support ticket solution or need to perform more advanced IT service management processes, Ivanti Neurons can flexibly scale and adapt to meet your specific business needs.
The Ivanti Neurons ITSM app built for the Orchestrate application helps security teams to perform ITSM related actions on the Ivanti Neuron ITSM application and enables security orchestration workflows. You can execute the following actions using the app.
Action | Description |
|---|---|
Create Journal | This action creates a journal in Ivanti Neurons. |
Generic Request | This action makes a generic endpoint request to Ivanti Neurons. |
Get User Details | This action retrieves the details of a user from Ivanti Neurons. |
Get Team Details | This action retrieves the details of a particular team from Ivanti Neurons. |
List Teams | This action retrieves the list of teams from Ivanti Neurons. |
Link Journal | This action links a journal to an incident in Ivanti Neurons. |
Get Journal Notes | This action retrieves the journal notes related to an incident from Ivanti Neurons. |
Update Incident | This action updates an incident on Ivanti Neurons. |
Upload Attachment | This action uploads an attachment to a particular business object on Ivanti Neurons. |
Close Incident | This action closes an incident on Ivanti Neurons. |
Create Service Request | This action creates a service request on Ivanti Neurons. |
Get Service Request | This action retrieves the details of a particular service request from Ivanti Neurons. |
Create Incident | This action creates an incident on Ivanti Neurons. |
Get Knowledge Base By Collection | This action retrieves the details of a particular knowledge base by collection from Ivanti Neurons. |
Get All Employees | This action retrieves the list of all employees from Ivanti Neurons. |
Get All Service Requests | This action retrieves the list of all service requests from Ivanti Neurons. |
Get Incidents Metadata | This action retrieves the metadata of all incidents in the last 12 months from Ivanti Neurons. |
Get Incident | This action retrieves details of a particular incident from Ivanti Neurons. |
Get All Incidents | This action retrieves the list of all of the incidents from Ivanti Neurons. |
Get All Service Request Templates | This action retrieves the list of all service request templates from Ivanti Neurons. |
Update Service Request | This action updates a service request to Ivanti. |
Get the Attachments | This action retrieves attachments from business objects. |
Get Business Objects | This action retrieves all the related business objects that are linked to a business object. |
Link Business Objects | This action links different business objects based on relationships. |
Configuration Parameters
The following configuration parameters are required for the Ivanti Neuron Cloud ITSM App to communicate with the Ivanti Neurons ITSM application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the Base URL, FQDN, or IP address of the SMS server. Example: Base URL as https://<host>.<tld> | Text | Required |
|
API Token | Enter the API Token for authentication. | Text | Required |
|
Verify | Choose to verify SSL certificate while making requests | Boolean | Optional | Allowed values:
Default value: False |
Timeout | Enter the timeout value in seconds for the actions. | Integer | Optional | Allowed values: 15 - 120 seconds Default value: 15 seconds |
Action: Create Journal
This action creates a journal in Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Incident Rec ID | Enter the incident record ID. | Text | Required | Any business object such as change, problem, incident, can be identified using RecID. The business object is linked to a journal. For this action, you need the RecID of the Incident. |
Journal Notes | Enter the notes for your journal. | Text | Required |
|
Example Request
[
{
"journal_notes": "test note added",
"incident_rec_id": "7EE46670962C4BC6AA31BF1F6DE2153A"
}
]Action: Generic Request
This action makes a generic endpoint request to Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Business Object | Enter the business object for the request | Text | Required | Business Object can be a Change, User, Problem, Incident, and so on. |
Method | Enter the HTTP call method. For Example,
| Text | Required | Example: HTTP methods |
Params | Enter the parameters for the request. | Key-Value | Optional |
|
Data | Enter the data that you want to pass with the request. | Key-Value | Optional |
|
Example Request
[
{
"data": {},
"method": "GET",
"params": {},
"business_object": "employees?$filter=LoginID eq 'lisa.miller'"
}
]Action: Get User Details
This action retrieves the details of a user from Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Get User Details | Enter the name of the user. | Text | Required |
|
Example Request
[
{
"user_name": "lisa.miller"
}
]Action: Get Team Details
This action retrieves the details of a particular team from Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Team Name | Enter the name of the team. | Text | Required |
|
Example Request
[
{
"team_name": "Healthcare IT"
}
]Action: List Teams
This action retrieves the list of teams from Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the response limit. | Text | Optional |
|
Example Request
[
{
"limit": "5"
}
]Action: Link Journal
This action links a journal to an incident in Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Incident Rec ID | Enter the RecID for the incident. The Incident will be linked to the provided Journal RecID. | Text | Required |
|
Journal Rec ID | Enter the RecID for the journal. The journal will be linked to the provided incident RecID. | Text | Required |
|
Example Request
[
{
"journal_rec_id": "9B537xxxxxDC44489xxxxx97353494D5",
"incident_rec_id": "71964xxxxx754D2A8xxxxx49D6CE3FB4"
}
]Action: Get Journal Notes
This action retrieves the journal notes related to an incident from Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Incident Rec ID | Enter the RecID for the Incident | Text | Required |
|
Example Request
[
{
"incident_rec_id": "71964Axxx754D2xxxxx5849D6CxxxB4"
}
]Action: Update Incident
This action is updates an incident on Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Incident Rec ID | Enter the RecID for the Incident. | Text | Required |
|
Subject | Enter the subject to update. | Text | Optional |
|
Symptom | Enter the symptom to update. | Text | Optional |
|
Service | Enter the service to update. | Text | Optional |
|
Category | Enter the category to update. | Text | Optional |
|
Urgency | Enter the urgency to update. | Text | Optional |
|
Impact | Enter the impact to update. | Text | Optional |
|
Owner | Enter the owner to update. | Text | Optional |
|
Source | Enter the source to update. | Text | Optional |
|
Extra Parameters | Enter other parameters that need to be updated. | Key-Value | Optional |
|
Example Request
[
{
"incident_rec_id": "71964xxx54754D2xxxx5849D6CE3xx4"
"subject": "Update Incident API Testing",
"symptom": "I'd like to update an incident via API",
"service": "Service update",
"category": "Service Desk",
"urgency": "Low",
"impact": "Minimal",
"owner": "BHeath",
"status": "Active",
}
]Action: Upload Attachment
This action uploads an attachment to a particular business object on Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
File Path | Enter the file path for the file to be uploaded. | Text | Required |
|
File Name | Enter the file name to be saved on Ivanti. | Text | Required |
|
Object Rec ID | Enter the Object RecID. | Text | Required |
|
Object Type | Enter the object type. Example: Incident | Text | Required |
|
File Type | Enter the text type to be attached. | Text | Required |
|
Example Request
[
{
"file_name": "file_upload.txt",
"file_path": "/tmp/81e75094-6eb8-4d44-b485-e37d9ccd33e5/cyware.txt",
"file_type": "text/plain",
"object_type": "incident#",
"object_rec_id": "AA76DB60D6E5479AB113E060314821C9"
}
]Action: Close Incident
This action closes an incident on Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Incident Rec ID | Enter the RecID for the Incident | Text | Required |
|
Action ID | Enter the action ID that needs to be performed | Text | Required |
|
Password Field | Enter the value to be passed for prompt data fields. By default, the value is False. | Boolean | Optional |
|
Password Required | Enter the value to be passed in the prompt data password required | Boolean | Optional |
|
Hidden | Enter if you want to hide the prompt data param fields | Boolean | Optional |
|
Example Request
[
{
"action_id": "34xxxxcc-e502-xxxx-9790-e3e4xxxx6c45",
"incident_rec_id": "AA76xxxxx6E5479ABxxxxx603148xxC9"
}
]Action: Create Service Request
This action creates a service request on Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Profile Link Rec ID | Enter the RecID link of your profile link. | Text | Required |
|
Service Request TMPL Link | Enter the TPML link for the service request. | Text | Required |
|
Created By | Enter the name of the user creating the service request. | Text | Required |
|
Symptom | Enter the symptom description here. | Text | Required |
|
Owner | Enter the name of the owner for the service request. | Text | Required |
|
Owner Team | Enter the team to which the owner belongs to. | Text | Required |
|
Owner Team Valid ID | Enter the ID for the Owner team. | Text | Required |
|
Owner Valid | Enter the valid ID for the Owner. | Text | Required |
|
status | Enter the status of the service request. Example: Active. | Text | Required |
|
Example Request
[
{
"owner": "BHeath",
"status": "Active",
"symptom": "SR Creation Via API",
"created_by": "Admin",
"owner_team": "Accounting",
"owner_valid": "1470xxxx247F6B177xxxxx4C5E39C",
"owner_team_valid": "8D79637xxxx546AC9008C0EDxxxxxEE5F",
"svc_req_tmpl_link": "BA68CD75D172xxxxxxD93DC45D67",
"profile_link_rec_id": "2F85xxxxFE5437C97D19xxxxx39C7"
}
]Action: Get Service Request
This action retrieves details of a particular service request from Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Service Request Number | Enter the service request number. | Text | Required |
|
Example Request
[
{
"service_request_number": "10197"
}
]Create Incident
This action creates an incident on Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Profile Link Rec ID | Enter the Profile link RecID from Ivanti. | Text | Required |
|
Category | Enter the category for the incident to sort into. | Text | Required |
|
Created By | Enter the name of the user creating the incident. | Text | Required |
|
Symptom | Enter the symptom description for the incident. | Text | Required |
|
Owner | Enter the name of the owner. | Text | Required |
|
Owner Team | Enter the name of the team for the owner. | Text | Required |
|
Subject | Enter the subject for the incident. | Text | Required |
|
Owner Team Valid ID | Enter the valid team ID for the owner. | Text | Required |
|
Owner Valid | Enter the valid ID for the owner. | Text | Required |
|
Status | Enter the status of the Incident. For example, Active. | Text | Required |
|
Action: Get Knowledge Base By Collection
This action retrieves details of a particular knowledge base by collection from Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Collection Name | Enter the name of the connection to get the knowledge base. | Text | Required |
|
Example Request
[
{
"collection_name": "Information Security"
}
]Action: Get All Employees
This action is used to get the list of all employees from Ivanti Neurons.
Input Parameters
No input parameters are required for this action.
Action: Get All Service Requests
This action is used to get the list of all service requests from Ivanti Neurons.
Input Parameters
No input parameters are required for this action.
Action: Get Incidents Metadata
This action is used to get metadata of all incidents in the last 12 months from Ivanti Neurons.
Input Parameters
No input parameters are required for this action.
Action: Get Incident
This action is used to get details of a particular incident from Ivanti Neurons.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Incident Number | Enter the Incident Number to get details. | Text | Required |
|
Example Request
[
{
"incident_number": "11170"
}
]Action: Get All Incidents
This action is used to get the list of all of the incidents from Ivanti Neurons.
Input Parameters
No input parameters are required for this action.
Action: Get All Service Request Templates
This action is used to get the list of all service request templates from Ivanti Neurons.
Input Parameters
No input parameters are required for this action.
Action: Update Service Request
This action updates a service request.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Record ID | Enter the record ID to update the service request. Example: "6730C50F52xxx1A81FFE15D7D60725F" | Text | Required |
|
Changes | Enter the changes to be updated as key-value pairs. Example: $JSON[{'Category': 'Software'}] | Key Value | Required |
|
Example Request
[
{
"rec_id": "6730C50Fxx7A481AxxFE15D7D60725F",
"changes": {'Category': 'Software'}
}
]Action: Get the Attachments
This action retrieves attachments from business objects.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Rec ID | Enter the record ID. Example: "6730C50F527AxxxA81FFE15D7D60725F" | Text | Required |
|
Example Request
[
{
"rec_id": "6730C50Fxx7A481AxxFE15D7D60725F"
}
]Action: Get Business Objects
This action retrieves all the related business objects that are linked to a business object.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Business Object Name | Enter the business object name. Example: "incidents" | Text | Required |
|
Business Object Unique Key | Enter the business object unique key. Example: "6730C50F527A48xxFFE15D7D60725F" | Text | Required |
|
Business Object Relationship Name | Enter the business object relationship name. Example: "IncidentContainsJournal" | Text | Mandatory |
|
Example Request
[
{
"buss_obj_name": "incidents",
"buss_obj_key":"6730C50F527A48xx15D7D60725F",
"buss_obj_rel_name": "IncidentContainsJournal"
}
]Action: Link Business Objects
This action links different business objects based on relationships.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Business Object Name | Enter the business object name. Example: "incidents" | Text | Required |
|
Business Object Unique Key | Enter the business object unique key. Example: "6730C50F527A481xxFFE15D7D60725F" | Text | Required |
|
Business Object Relationship Name | Enter the business object relationship name. Example: "IncidentContainsJournal" | Text | Required |
|
Business Object Relationship Unique Key | Enter the unique key of the related business object. Example: "4F34DB8563DFxxE5381CDA9805B21" | Text | Required |
|
Example Request
[
{
"buss_obj_name": "incidents",
"buss_obj_key": "6730C50F527A481A8xxE15D7D60725F",
"buss_obj_rel_name": "IncidentContainsJournal",
"buss_obj_rel_key": "4F34DB8563DF450CAExx1CDA9805B2"
}
]