ManageEngine ServiceDesk Plus - Partner connection
The ServiceDesk Plus - Partner connection represents a single ServiceDesk Plus Cloud portal, including its service domain, portal name, and OAuth 2.0 login credentials. If you connect to multiple portals or accounts, use a separate connection for each one. Pair a single connection with a ServiceDesk Plus Cloud operation to perform actions against that portal.
Connection tab
Configure the following fields on the Connection tab:
| Name | Description |
|---|---|
| Service Domain | The ServiceDesk Plus Cloud service domain URL for your data center (for example, https://sdpondemand.manageengine.com). Defaults to the US data center domain. |
| Portal Name | Your ServiceDesk Plus Cloud portal name, as it appears in your portal URL. The connector uses this value, along with the service domain, to build the API path for every request. For example, if https://sdpondemand.manageengine.com/app/itdesk/HomePage.do is your homepage URL, then itdesk is your portal name. |
OAuth 2.0 tab
ServiceDesk Plus Cloud uses the OAuth 2.0 protocol for authentication and authorization through Zoho's identity platform. The connection fetches OAuth 2.0 credentials from the Zoho authorization service, extracts a token from the response, and sends it to the ServiceDesk Plus Cloud API you are requesting access to. The connector automatically manages token refresh, so the connection continues to work after the initial access token expires.
| Name | Description |
|---|---|
| Grant Type | The OAuth 2.0 grant type. Only Authorization Code is supported for ServiceDesk Plus Cloud. |
| Authorization Token Endpoint | The Zoho authorization endpoint that matches your data center (for example, the US endpoint is https://accounts.zoho.com/oauth/v2/auth). |
| Access Token Endpoint | The Zoho token endpoint that matches your data center (for example, the US endpoint is https://accounts.zoho.com/oauth/v2/token). |
| Scope | A comma-separated list of OAuth scopes that determine which modules and operations (ALL, CREATE, READ, UPDATE, DELETE) the connection is authorized to use, for example, requests, setup, problems, changes, assets, or CMDB. |
| Client ID | Enter or paste the Client ID from the Zoho API Console for your registered OAuth application. |
| Client Secret | Select Click to Set to open the Password window, enter or paste your Client Secret, and click Apply. Enable pop-up windows in your browser. |
| Access Token | Click Generate. A window opens asking you to sign in to ServiceDesk Plus Cloud and approve access for the requested scopes. On approval, Boomi receives and stores the access and refresh tokens for the connection. |
Additional tasks
The following additional task is required to successfully implement the ManageEngine ServiceDesk Plus Cloud connector.
Registering an OAuth client for ServiceDesk Plus Cloud
About this task
Before you can configure the OAuth 2.0 tab of the ServiceDesk Plus Cloud connection, you must register an OAuth client (application) in the Zoho API Console for the data center that hosts your ServiceDesk Plus Cloud account. This provides the Client ID and Client Secret the connection needs, and it authorizes Boomi to request access on your behalf.
Steps
- Go to the Zoho API Console for your data center (for example,
https://api-console.zoho.com/for the US data center). - Create a new client of the appropriate type (for example, Server-based Applications).
- In the Authorized Redirect URIs field, enter the Boomi callback URL:
https://platform.boomi.com/account/<your_BoomiPlatform_account_ID>/oauth2/callback. You can find your Boomi Platform account ID under Setup > Account > Account Information. - Save the client and record the generated Client ID and Client Secret.
Next steps
Enter the Client ID and Client Secret on the OAuth 2.0 tab of the ServiceDesk Plus Cloud connection, set the Scope field to the scopes your integration requires, and click Generate to complete the authorization and obtain an access token.
