Deskpro Single Sign-On (SSO)

Deskpro with its adaptable and dynamic helpdesk software can provide you the unforgettable customer experiences to your customers or internal users. miniOrange allows you to setup Single Sign-On(SSO) into using two standard protocols like SAML 2.0 and JSON web Tokens (JWT). Deskpro SSO with JWT is achieved by protocol brokering between JWT and SAML. Deskpro has support for SSO using JSON Web Token (JWT) tokens. miniOrange allows your users to Single Sign-On into Deskpro by verifying Identity with your existing SAML 2.0 compliant Identity Provider and passing JWT tokens to Deskpro.

Prerequisites

Please make sure your organisation branding is already set under Customization >> Login and Registration Branding in the left menu of the dashboard.

Connect with External Source of Users

miniOrange provides user authentication from various external sources, which can be Directories (like ADFS, Microsoft Active Directory, OpenLDAP, AWS etc), Identity Providers (like Microsoft Entra ID, Okta, AWS), and many more. You can configure your existing directory/user store or add users in miniOrange.

Follow the Step-by-Step Guide given below for Deskpro Single Sign-On (SSO)

. Configure Deskpro in miniOrange

Go to Apps and click on Add Application button.

In Choose Application, select JWT from the application type dropdown.

In the next step, search for Deskpro application from the list. If your application is not found, search for JWT App and you can set up your Application.

Configure JWT application: Search Deskpro JWT application

You can configure the following details in the application:

Custom App Name	Enter the Application Name of your choice, and add a description if required.
Redirect-URL	Enter the Redirect-URL (i.e. the endpoint where you want to send/post your JWT). You can add multiple redirect URLs by separating them with a ‘;’. E.g. abc.com;xyz.com
Primary Identity Provider (optional)	Select your Identity Source from the dropdown. You can select miniOrange here as default IDP.

Click on Save to complete the configuration.
Click on Edit in the ' ' icon against your app.

You can get further details about your recently added JWT application:

Client ID	If your application provides its own client ID, you can configure it by clicking on the Customize button.
App Secret	You can find App Secret by clicking on the copy icon. This is used in the HS265 Signature algorithm for generating the signature.
Signature Algorithm	Select RSA-SHA256 as your signature algorithm from the dropdown.
Primary Identity Provider	Select the default Identity Provider from the dropdown for the application. If not selected, users will see the screen of default IdP (miniOrange)
Redirect URL	Enter your app’s URL here (This is the URL where you will receive your JWT.) <app-login-url>/?id_token=<token> eg: https://localhost:3000/home/?id_token=eyefb43bf.whfeeg.hfwf In this example, https://localhost:3000/home is my app’s URL where id_token will be posted after authentication.

Scroll down to Endpoints.

SSO URL for using miniOrange as Authentication Source: If you are going to store users in miniOrange and use miniOrange as your authentication source,then, copy and save this URL somewhere as it will be used in further steps.
SSO URL for using External Providers as Authentication Source: If you are going to use any External Provider as your authentication source, then, Copy this one and save somewhere as it will be used in further step.

2. Setup SSO in DeskPRO

Login to Deskpro dashboard as a user with administrator permissions and navigate to Agents >> Auth & SSO or CRM >> Auth & SSO, depending on whether you want to authenticate agents or users.

deskpro single sign-on (sso) navigate dashboard

Click on Add button and select JSON Web Token (JWT).
Enter Remote Login URL as https://login.xecurify.com/moas/broker/login/jwt/<customer-id>?client_id=<client-id>&redirect_uri=<your_domain>.deskpro.com and JWT Secret Code that you get from the above step.
Enter Login Button Text as Login With JWT.
Check Enabled? option and click on Install App button.

deskpro single sign-on (sso) click on install button

Then, click on Save Settings and Test your configurations by clicking on Test Settings.

deskpro single sign-on (sso) test configuration details

3. Configure Your User Directory

miniOrange provides user authentication from various external sources, which can be Directories (like ADFS, Microsoft Active Directory, Microsoft Entra ID, OpenLDAP, Google, AWS Cognito etc), Identity Providers (like Okta, Shibboleth, Ping, OneLogin, KeyCloak), Databases (like MySQL, Maria DB, PostgreSQL) and many more. You can configure your existing directory/user store or add users in miniOrange.

Setup miniOrange as IDP
Setup AD as User Directory
Setup External IDP

To add your users in miniOrange there are 2 ways:

1. Create User in miniOrange

2. Bulk Upload Users

1. Create User in miniOrange

Click on Users >> User List >> Add User.

Deskpro VPN 2FA : Add user in miniOrange

Here, fill the user details without the password and then click on the Create User button.

After successful user creation a notification message "An end user is added successfully" will be displayed at the top of the dashboard.

Deskpro Two-Factor Authentication: Add user details

Click on Onboarding Status tab. Check the email, with the registered e-mail id and select action Send Activation Mail with Password Reset Link from Select Action dropdown list and then click on Apply button.

Now, Open your email id. Open the mail you get from miniOrange and then click on the link to set your account password.
On the next screen, enter the password and confirm password and then click on the Single Sign-On (SSO) reset password button.

Deskpro Multi-Factor Authentication: Reset user password

Now, you can log in into miniOrange account by entering your credentials.

2. Bulk Upload Users in miniOrange via Uploading CSV File.

Navigate to Users >> User List. Click on Add User button.

In Bulk User Registration Download sample csv format from our console and edit this csv file according to the instructions.

Deskpro Two-Factor authentication: Download sample csv file

To bulk upload users, choose the file make sure it is in comma separated .csv file format then click on Upload.

After uploading the csv file successfully, you will see a success message with a link.
Click on that link you will see list of users to send activation mail. Select users to send activation mail and click on Send Activation Mail. An activation mail will be sent to the selected users.

Click on External Directories >> Add Directory in the left menu of the dashboard.

Select Directory type as AD/LDAP.

Deskpro 2FA: Select AD/LDAP as user store

STORE LDAP CONFIGURATION IN MINIORANGE: Choose this option if you want to keep your configuration in miniOrange. If active directory is behind a firewall, you will need to open the firewall to allow incoming requests to your AD.
STORE LDAP CONFIGURATION ON PREMISE: Choose this option if you want to keep your configuration in your premise and only allow access to AD inside premises. You will have to download and install miniOrange gateway in your premise.

Deskpro Two-Factor Authentication : Select ad/ldap user store type

Enter LDAP Display Name and LDAP Identifier name.
Select Directory Type as Active Directory.
Enter the LDAP Server URL or IP Address against LDAP Server URL field.
Click on Test Connection button to verify if you have made a successful connection with your LDAP server.

Deskpro MFA/2FA: Configure LDAP server URL Connection

In Active Directory, go to the properties of user containers/OU's and search for Distinguished Name attribute.

Deskpro MFA: Configure user bind account domain name

Enter the valid Bind account Password.
Click on Test Bind Account Credentials button to verify your LDAP Bind credentials for LDAP connection.

Deskpro MFA: Check bind account credentials

Search Base is the location in the directory where the search for a user begins. You will get this from the same place you got your Distinguished name.

Deskpro 2FA : Configure user search base

Select a suitable Search filter from the drop-down menu. If you use User in Single Group Filter or User in Multiple Group Filter, replace the <group-dn> in the search filter with the distinguished name of the group in which your users are present. To use custom Search Filter select "Write your Custom Filter" option and customize it accordingly.

Deskpro MFA/2FA : Select user search filter

You can also configure following options while setting up AD. Enable Activate LDAP in order to authenticate users from AD/LDAP. Click on the Save button to add user store.

Here's the list of the attributes and what it does when we enable it. You can enable/disable accordingly.

Attribute	Description
Activate LDAP	All user authentications will be done with LDAP credentials if you Activate it
Sync users in miniOrange	Users will be created in miniOrange after authentication with LDAP
Fallback Authentication	If LDAP credentials fail then user will be authenticated through miniOrange
Allow users to change password	This allows your users to change their password. It updates the new credentials in your LDAP server
Enable administrator login	On enabling this, your miniOrange Administrator login authenticates using your LDAP server
Show IdP to users	If you enable this option, this IdP will be visible to users
Send Configured Attributes	If you enable this option, then only the attributes configured below will be sent in attributes at the time of login

Click on Save. After this, it will show you the list of User stores. Click on Test Connection to check whether you have enter valid details. For that, it will ask for username and password.

On Successful connection with LDAP Server, a success message is shown.
Click on Test Attribute Mapping.

Enter a valid Username. Then, click on Test. Mapped Attributes corresponding to the user are fetched.

Deskpro MFA: Fetch mapped attributes for user

After successful Attribute Mapping Configuration, go back to the ldap configuration and enable Activate LDAP in order to authenticate users from AD/LDAP.

Refer our guide to setup LDAPS on windows server.

User Import and Provisioning from AD

Go to Settings >> Product Settings in the Customer Admin Account.

MFA/Two-Factor Authentication(2FA) for miniOrange dashboard

Enable the "Enable User Auto Registration" option and click Save.

MFA/Two-Factor Authentication(2FA) for Enable User Auto Registration

(Optional) To send a welcome email to all the end users that will be imported, enable the "Enable sending Welcome Emails after user registration" option and click Save.

MFA/Two-Factor Authentication(2FA) for Enable sending Welcome Emails after user registration

From the Left-Side menu of the dashboard select Provisioning.

MFA/Two-Factor Authentication(2FA) for User Sync/Provisioning

In Setup Provisioning tab select Active Directory in the Select Application drop-down.
Toggle the Import Users tab, click on Save button.

MFA/Two-Factor Authentication(2FA) for User Sync Active Directory Configuration

On the same section, switch to Import Users section.
Select Active Directory from the dropdown and click on the Import Users tab, to import all the users from Active Directory to miniOrange.

MFA/Two-Factor Authentication(2FA) for User Sync Import Operation

You can view all the Users you have imports by selecting Users >> User List from Left Panel.

MFA/Two-Factor Authentication(2FA) for User List

All the imported users will be auto registered.
These groups will be helpful in adding multiple 2FA policies on the applications.

miniOrange integrates with various external user sources such as directories, identity providers, and etc.

Not able to find your IdP or Need help setting it up?

Contact us or email us at idpsupport@xecurify.com and we'll help you setting it up in no time.

Using SP Initiated Login

Lets say you have configured miniOrange as your userstore.
On accessing the Single sign-On URL as mentioned in the second step, you will be asked for miniOrange credentials.

Deskpro Single Sign-On (SSO): miniOrange Login

On entering the valid credentials, you will be successfully logged into Deskpro.

Deskpro Single Sign-On (SSO): Deskpro Login

Using IDP Initiated Login

Log into miniOrange IdP using your credentials.
On the End User-Dashboard, click on the Deskpro application configured, to test the SSO flow.

Deskpro Single Sign-On (SSO): verify configuration

You will be successfully logged into Deskpro.

Using SP Initiated Login

Lets say you have configured Okta as IDP.
On accessing the Single sign-On URL as mentioned in the second step, you will be asked to enter your Okta credentials.

On entering the valid credentials, you will be successfully logged into Deskpro.

Using IDP Initiated Login

Log into Okta using your credentials.
Click on Admin to access the Admin Console, then click on Applications.
Click on Add Application and search for "Bookmark App", and Click Add in the left pane.
Choose an app name of your choice which will be the display name.
In the URL section, enter the SSO URL that is given in the JWT app.

Deskpro Single Sign-On (SSO): Deskpro add bookmark app

Click on Save.
On the End User-Dashboard, click on the Deskpro bookmark application configured, to test the SSO flow.

You will be successfully logged into Deskpro.

External References

Frequently Asked Questions

How can I check RADIUS User audit logs in miniOrange admin dashboard?

Yes, you can connect any external IdP like Gsuite, Okta, AzureAD etc or authenticate from any user store like miniOrange, Active Directory, Database etc and SSO into Deskpro. After authentication miniOrange would send a JWT token to Deskpro which is used by Deskpro for logging the user in. You can read about it here.

Want To Schedule A Demo?

Contents

Deskpro Single Sign-On (SSO)

Prerequisites

Connect with External Source of Users

Follow the Step-by-Step Guide given below for Deskpro Single Sign-On (SSO)

. Configure Deskpro in miniOrange

2. Setup SSO in DeskPRO

3. Configure Your User Directory

User Import and Provisioning from AD

Not able to find your IdP or Need help setting it up?

4. Test SSO Configuration

Using SP Initiated Login

Using IDP Initiated Login

Using SP Initiated Login

Using IDP Initiated Login

External References

Frequently Asked Questions

How can I check RADIUS User audit logs in miniOrange admin dashboard?

Want To Schedule A Demo?

Single Sign-On

Multi-factor Authentication

Adaptive Authentication

Lifecycle Management

STAY CONNECTED