Connections

Connections are used to authenticate ServiceDesk Plus MSP integration with external applications.

To set up connections, register the third party application as a service in ServiceDesk Plus MSP. Connections are equipped with three modes of authentication - API key, basic authentication, and OAuth 2.0.

Role Required: SDAdmin

Benefits

Secure authentication mechanism that prevents exposure of an user's authentication token to other users in the application.
Dynamic token generation (refresh tokens) for OAuth.

Set Up Connections

Go to Admin > Developer Space > Connections.

Step 1: Store the third party application details as a service.

Under Connections pane, select Custom Services and click Create Service. Fill out the form using the pointers below.

Field Name	Description
Service Name	Provide a display name for the service.
Service Link Name	Provide a unique link name to identify the custom service. The link name must contain only alphanumeric characters in snake_case.
Authentication Type	Choose an authentication type based on the third-party service's API documentation. API Key •Specify the parameter type as query string, form data, or header. •Enter the parameter and the display name of the parameter. •Click to add multiple parameters. You can delete parameters by clicking . Basic Authentication The parameter type is auto-populated as Header and is non-editable.The service is authenticated using the username and password details. OAuth2 Specify the identity provider details. Ensure the callback URL is: {sdp_base_URL}/integration/oauth/callback and the domain name is the alias URL configured under Admin > General Settings > Advanced Portal Settings. •The parameter type is selected as Header by default. •The grant type is selected as Authorization Code by default. •Copy the client ID provided in the resource owner. •Copy the client secret mapped to ServiceDesk Plus from the resource owner. •Enter the authorization URL of the login page of the resource, where ServiceDesk Plus MSP can be authenticated with the resource server. •Provide the access token URL from the resource's website. •Provide the refresh token URL to allow ServiceDesk Plus MSP to reauthorize access. You can obtain this URL from the resource's website. •Provide the access permissions required by ServiceDesk Plus MSP as scope and enter a scope display name.

Click Create Service.

Step 2: Create Connection

Authenticate the service integrated via connections. Under Connections pane, select My Connections and click Create Connection. You can also create connections from the service details page.

Pick the service for which the connection must be created. You can also create a new service.
Provide a display name for the connection.
Provide a unique link name to identify the connection. The link name must contain only alphanumeric characters in snake_case.
For services authenticated via OAuth2, choose the relevant permissions.
Click Create and Connect.
Provide the relevant authentication details and permissions.

For existing connections, click Connect on the connection details page to connect to the external service.

Manage Services and Connections

On the connection/service details page,

Click to edit or delete the connection/service
On the connection details page, you can initiate or revoke a connection.

On the connection/service list view page,

Click to search using connector display name or link name.
Click to filter the connections listed.
Hover over a service or connection to edit/delete/connect/revoke it.

Services with existing connections cannot be deleted or edited, except for Service Name field and Separator field (if OAuth2 is configured).

You can edit or delete any connection created by you. SDAdmins can connect (authenticate) any connections available.

Connections used in custom widgets cannot be deleted.

Connections can be revoked only by authenticated users or by the user who created the connection.