Integration Key 

ServiceDesk Plus 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:

 

 

  1. 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.

 

 

Ensure that the password provided here is the same as the password used to log in to the current session.

 

  1. 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 on the list view page.

 

 

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

  2. Click Reassign. A confirmation message pops up.

  3. Click Yes to proceed.

After you reassign a key to another technician, you cannot perform any action on the key.

 

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.

 

 

On deleting a key, all integrations configured using the key will be disabled forever.

 

To delete keys in bulk,

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

  2. Click Delete on the toolbar.

  3. A confirmation message pops up. Click Yes to proceed.

  4. The selected keys will be deleted from the list view page.

 

  

 

URL rate limit violations

View the list URLs that have violated access limits. Note that these URLs are accessed by using an integration key.

 

Every URL has a predefined rate limit configured internally. When the rate limit is reached, the connection to the requested URL will be blocked for a specific time frame and the SDAdmin will be notified.

 

The URL rate limit violations include details such as the IP address of the machine, the user details used to access the URL, the date and time of the violation, the threshold limit for the URL, the time frame within which you can make a certain number of requests, and the integration keys used to access the URL.

 

Role required: SDAdmin

 

You can now modify the threshold limits of these URLs but not the time duration given.

There is a predefined threshold limit for each URL. The entered value shouldn't exceed thrice the predefined value set.

Raising the URL rate limit could impact application performance and lead to DOS (Denial of Service) attacks. 

 

To modify the access limit of the URLs,

  1. Click URL rate limit violations. The URL access violation alert pop-up is displayed.

 

  1. Select the URL from the Impacted URL list.

  2. In the displayed window, under Configure Rate Limit, click Edit.

4. URL rate limit - Enter the allowed number of requests for the URL.

5. Select the integration keys.

6. Click Update to save the changes. The information about the last modified user, date, and time is displayed in the same window.

Alternatively, you can modify the rate limit by clicking on the notifications. Click here to learn how to turn on notifications.

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.

 

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

  2. 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.

  3. 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 servicedeskplus-support@manageengine.com. 

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

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

 

Notification Settings

Configure notifications to alert technicians about the expiry of integration keys.