Kayako Single Sign-On (SSO)
Kayako 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 Kayako using two standard protocols like SAML 2.0 & JSON Web Token (JWT). Kayako SSO with JWT is achieved by protocol brokering between JWT & SAML. miniOrange allows your users to Single Sign-On into Kayako by verifying Identity with your existing SAML 2.0 compliant Identity Provider and passing JWT tokens to Kayako. Combining the power of Kayako platform with miniOrange IAM platform allows users to quickly & seamlessly log into their Kayako Account. This combination increases employee productivity from day one and also ensures a secure experience with minimal IT overhead.
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.
Prerequisites
Please make sure your organisation branding is already set under Customization >> Login and Registration Branding in the left menu of the dashboard.
Follow the Step-by-Step Guide given below for Kayako Single Sign-On (SSO)
. Configure Kayako 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 Kayako application from the list. If your application is not found, search for JWT App and you can set up your 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 Kayako
- Sign in to the admin area.
- Choose either the 'Agents' or 'Customers' tab at the top. The configuration options will be the same for both types of users.
- On the Security section in the sidebar, click Authentication.
- Add the login URL for your remote system to the Remote login URL field.
https://brandingtest.miniorange.in/moas/broker/login/jwt/{customer-id}
- From the Authentication drop-down list, select 'Single sign-on (JWT),' which will open up another set of configuration options.
- Paste the token you've created for Kayako into the Shared SSO secret field.
- Add the logout URL for your remote system to the Remote logout URL field.
https://brandingtest.miniorange.in/moas/broker/login/jwt/logout/18462?client_id=vHm65fYQ0cSdXTLz&redirect_uri={your-application-logout-url}
- Click the Save button to save the changes.
- Enter a short, descriptive name for your remote authentication service in the Remote system name field.
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.
- Click on External Directories >> Add Directory in the left menu of the dashboard.
- Select Directory type as AD/LDAP.
- 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.
- 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.
- In Active Directory, go to the properties of user containers/OU's and search for Distinguished Name attribute.
- Enter the valid Bind account Password.
- Click on Test Bind Account Credentials button to verify your LDAP Bind credentials for LDAP connection.
- 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.
- 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.
- 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.
- 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.
- Enable the "Enable User Auto Registration" option and click Save.
- (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.
- From the Left-Side menu of the dashboard select Provisioning.
- In Setup Provisioning tab select Active Directory in the Select Application drop-down.
- Toggle the Import Users tab, click on Save button.
- 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.
- You can view all the Users you have imports by selecting Users >> User List from Left Panel.
- 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.
4. Test SSO Configuration
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.
- On entering the valid credentials, you will be successfully logged into Kayako.
Using IDP Initiated Login
- Log into miniOrange IdP using your credentials.
- On the End User-Dashboard, click on the Kayako application configured, to test the SSO flow.
- You will be successfully logged into Kayako.
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 Kayako.
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.
- Click on Save.
- On the End User-Dashboard, click on the Kayako bookmark application configured, to test the SSO flow.
- You will be successfully logged into Kayako.
External References
