Integration Key   

ServiceDesk Plus MSP enables administrators configure multiple API keys to allow delegated access for different integration requirements. Apart from creating and managing integration keys, administrators can also reassign them to different technicians as and when they are required.

Add a new key   

To add a new integration key,

1. Go to Admin > Developer Space (Apps & Add-ons in the old UI) > Integration Key.

2. Click New.

3. Fill out the displayed form using the pointers given below:

• Name: Provide a unique name for the integration key.

• Roles: Select the roles to associate with the key.

• Key expires on: Choose whether the key has a validity period. Configure the expiry date if you choose the Expires on option.

• Description: Provide a short description or add notes on the integration key.

4. Click Generate. The key will be created.

View key  

All generated keys will be encrypted on the list view page. To view a specific key,

1. Click the key name.

2. In the displayed pop-up, enter your application login password.

3. Click View to display the integration key. You can copy the key to use it in performing REST API calls.

Edit key  

You can edit the keys you own to modify the associated roles, change status, or extend the validity period. However, the edit action will update the modified details without altering the actual key generated.

To edit a key,

1. Click  > Edit beside the required key in the list view page.

2. In the displayed window, modify the required details.

3. Click Update to complete the action.

Assign key   

You can assign an integration key to other SDAdmins users. To reassign a key,

1. Click  > Reassign beside the required key in the list view page.

2. In the displayed window, select the technician and add relevant comments.

3. Click Reassign. A confirmation message pops up.

4. Click Yes to proceed. The key will be assigned to the selected technician.

To reassign keys in bulk,

1. Select the required keys by enabling the checkboxes beside them.

2. Click Reassign in the list view page.

3. In the displayed window, select the technician and add relevant comments.

4. Click Reassign. A confirmation message pops up.

5. Click Yes to proceed.

Configure key status   

All integration keys will be active by default. To mark an integration key as inactive,

1. Click  > Edit beside the required key in the list view page.

2. In the displayed window, uncheck the Status option.

3. Click Update. The key will become inactive.

To activate a key, click  > Edit and enable the checkbox beside Status. Click Update to complete the action.

Apply filters

In the list view page, you can use filters to view the keys based on their status such as All, Active, Inactive, and Expired.

Delete key   

To delete an integration key,

1. Click  > Delete beside the key to delete. A confirmation message pops up.

2. Click OK to proceed. The key will be deleted from the application.

To delete keys in bulk,

1. Select the required keys by enabling the checkboxes beside them.
2. Click the delete icon   in the list view page.
3. A confirmation message pops up. Click Yes to proceed.
4. The selected keys will be deleted from the list view page.

Notifications  

This section lists the notifications triggered upon various activities performed in an integration key. You can view the notifications by clicking the bell icon  on the header panel.

• When an admin user reassigns a key to you, you will receive a push notification on the event.

• When the keys of a deleted user are auto-assigned to you, you will receive a push notification.

• The keys of a deleted user will be auto-assigned to you, if you have removed the user.
  
  

  If the user you deleted has keys configured in instances where you do not have access, the keys will be associated to a random user with admin privileges in that instance.

• If a key is about to expire in three days, the key owner will receive a push notification to take necessary action.

• To configure the day to send the reminder notification, contact support at servicedeskplusmsp-support@manageengine.com.

• When a key has expired, the key owner will receive a push notification.

• When a custom role associated with a key is deleted from the application, the key owner will receive a push notification.