This document describes the configurations required for SAML 2.0 integration between the Octopus Authenticator and ServiceDesk Plus.
The environment used for the integration described in this document is based on the following software versions:
Octopus Authentication Server version 5.0.2
ServiceDesk Plus 11.3 installed on Windows 2012 R2 server
The integration process involves the following sequential phases:
Creating the ServiceDesk Plus SAML Service: Add and configure the required SAML service in the Octopus Management Console
Configuring ServiceDesk Plus: Add Identity Provider details and enable SSO in your ServiceDesk Plus environment
Completing Service Integration: Add the ACS URL and other parameters to the Octopus SAML service
For an overview of the authentication process in runtime, refer to Running the Solution.
The following procedure explains how to create the required SAML service in the Octopus Management Console. The service settings will be used later in the ServiceDesk Plus configuration.
To add and configure the ServiceDesk Plus SAML service:
From the Octopus Management Console, open the Services menu. At the upper left corner of the page, click Add Service.
In the Generic SAML tile, click Add.
Then, in the dialog that opens, click Create.
Configure the following settings in the General Info tab:
Setting
Description
Service Name
Enter a display name to identify the Service Provider (e.g., ServiceDesk Plus).
Issuer
Enter the issuer of the service (e.g., ServiceDesk).
Description
Enter a brief note about the service.
Display icon
This icon will be displayed on the Login page for the service. To change the default icon, click and upload the image of your choice. (Supported image size is 488x488 pixels.)
Login Page URL
<https://<Enterprise Base URL>/saml/<random UUID>/login>
The Enterprise Base URL can be modified in System Settings > General Settings.
Then, click Save.
Open the Sign on tab, and update the default message in the Custom Message field. (This is the message displayed to the user upon successful login.)
Then click SAML METADATA to download the metadata.xml file. Save the file for later use.
At the bottom of the Sign on tab, click Save.
Open the Directories tab and select the checkboxes of the directories you want to integrate with the service. Then, click Save.
Open the Users tab and click Add.
A popup opens, with a list of directories displayed on the left.
Expand the directories list and select the checkboxes of the groups and users that you want to add to the service. Then, click Save to close the popup.
The groups and users you selected are listed in the Users tab.
At the bottom of the Users tab, click Save. Then, from the toolbar at the top of the page, click PUBLISH and publish your changes.
Follow the steps below to add the Octopus ServiceDesk SAML service as an identity provider in ServiceDesk Plus. You will need the following data from the Sign on tab of the service you created in the Octopus Management Console:
SAML 2.0 (Endpoint) HTTP: Click the Copy icon to copy the URL.
SAML Logout URL: Click the Copy icon to copy the URL.
X.509 Certificate: Click Download to download the certificate file.
 |
To add the SAML identity provider:
In the upper right corner of the ServiceDesk Plus app, click the Admin icon. Then, under Users, select SAML Single Sign On.
At the top of the Configuration tab, verify that the SAML Single Sign-On setting is enabled.
Under Configure Identity Provider Details, configure the following settings:
Login URL: Paste the SAML 2.0 (Endpoint) HTTP URL from the Octopus SAML service in this field.
Logout URL: Paste the SAML Logout URL from the Octopus SAML service in this field.
Certificate: Click Choose File and upload the X.509 certificate file from the Octopus SAML service.
Click Save.
To complete the integration process, you need to add the ACS URL and other service parameters to the Octopus Authenticator SAML service.
Before you begin, make sure you have access to the Assertion Consumer URL from your IdP setup in ServiceDesk Plus.
 |
To complete service integration:
Log into the Octopus Management Console and open the Services menu.
In the row or tile of the ServiceDesk Plus SAML service, click
to open the service settings.Open the Parameters tab, and configure the following settings:
Setting
Value / Notes
Octopus Authentication Login
The identifier required for the Octopus Authentication Server.
Name ID
Select Username.
Method
Select POST.
ASC URL
The Assertion Consumer URL from ServiceDesk Plus.
At the bottom of the Parameters tab, click Save. Then, from the toolbar at the top of the page, click PUBLISH and publish your changes.
This section describes the user experience of logging into ServiceDesk Plus via the Octopus Authenticator. The authentication process is as follows:
From a browser, the user opens the ServiceDesk Plus URL and clicks Log in with SAML Single Sign On.
The user is then redirected to the Secret Double Octopus login page.
The user enters a username or email and clicks Next.
The user then selects the authentication method (if relevant), and clicks Login.
A push notification appears on the user's authentication app, requesting authentication approval.
The user taps Approve.
After successful authentication, the user is logged into ServiceDesk Plus.
If you encounter errors with the ServiceDesk Plus application, please refer to the guidelines in their troubleshooting guide.
If the user is under a domain, the IdP must return the domain name together with the login name. To enable this behavior, create a nameIdentifierDomain parameter in the Octopus ServiceDesk Plus SAML service.
To add the nameIdentifierDomain parameter:
From the Octopus Management Console, select the Services menu.
In the row or tile of the ServiceDesk Plus SAML service, click
to open the service settings and select the Parameters tab.At the bottom of the tab, click Add Parameter and create the nameIdentifierDomain parameter:
In the New Parameter field, enter nameIdentifierDomain.
From the Parameter Value dropdown list, select Free Text.
In the field to the right, enter the domain value used for logging into ServiceDesk Plus. For example:
At the bottom of the Parameters tab, click Save.
From the toolbar at the top of the page, click PUBLISH and publish your changes.