Introduction
The 'SAML Service Provider Directory Manager' plugin facilitates effortless Single Sign-On (SSO) integration with Joget by enabling compatibility with various Identity Providers (IdPs). With this plugin, users can seamlessly authenticate and access Joget through their chosen IdP, enhancing the user experience and security of the platform.
Plugin Info
Plugin Available in the Bundle:
SAML Service Provider Directory Manager
This plugin bundle is compatible with Joget DX 8.
Expected Outcome
-
Getting Started
Prerequisites
The prerequisite for this plugin is to have a account with desired Identify Provider (IDP) and setup the App integration and obtain the IDP metadata and certificate. In this article we will using OKTA as the Identity Provider.
Please refer to following to read and understand more on Okta.
Okta
Identity Providers (IdPs): What They Are and Why You Need One
Okta Documentation
Setting up OKTA
1. Create a OKTA Developer Account at https://developer.okta.com/signup/ and compete the signup process.
2. Login to OKTA developer account at https://developer.okta.com/login/
3. Create App Integration
Go to your Okta developer account, and navigate to Applications > Create App Integration.
Figure 1: Okta Developer Dashboard - Creating App Integration
Choose SAML 2.0.
Figure 2: App Integration - SAML 2.0
After selecting SAML 2.0, pick a meaningful app name to represent Joget.
You may click on "Do not display application icon to users" if you do not want this app to appear in Okta's end user interfaces.
Figure 3: General Settings
In the next screen, we will be required to provide SSO URL and SP Entity ID.
Figure 4: SAML Settings
Here we will need Single sign-on URL & Audience URI (SP Entity ID). Please key in the following in both the fields
[server]:[port]/jw/web/json/plugin/org.joget.marketplace.SpSamlDirectoryManager/service
Replace the server and port with actual server credentials. For example localhost:8080
For this article we are using localhost as server and 9443 as port.
Change Name ID format onto EmailAddress.
Figure 5: SAML Setting (General)
Scroll down to Attribute Statements (optional) and fill up the attribute mappings. The mappings are needed to identify the users that will be logging in.
Figure 6: Attribute Statements
| Name | Value |
|---|---|
firstName | user.firstName |
lastName | user.lastName |
| user.email |
Complete the rest of the steps by clicking on Next and Finish. You may choose "I'm an Okta customer adding an internal app" for your testing purpose.
We are done setting up the app integration on Okta, next, we will need to configure Joget to point to Okta.
4. Getting IDP Metadata and Certification
Edit the app integration that we have just created on Okta.
Figure 7: Obtaining Metadata
Copy the Metadata URL and open it in a new window. Copy the entire content.
Figure 8: Metadata
Scroll down to look for SHA-2 cert and download certificate.
Figure 9: Download Certificate
Figure 10: Okta Certificate
We are done with setting up OKTA Developer Account and obtains the required items such as IDP Metadata and Certificate. We will not proceed to setup this plugin in Joget.
Plugin Setup
ddd
Upon clicking on the blue login button, the user will be redirected to Okta.
Plugin Setup
Source Code and Plugin Download
- Please visit https://github.com/jogetoss/sp-saml-directory-manager for the plugin's source code.
- You can find the latest release at https://github.com/jogetoss/sp-saml-directory-manager/releases.
- Upload the plugin to your Joget by navigating to Settings > Manage Plugins > Upload Plugin as admin.
Sample Setup using OKTA
Sample Screen Flow using OKTA As Provider
We will be using OKTA as the IDM provider in this article to walk through the steps of setting the plugin up. After it is enabled, on the login page, we will be seeing an additional login (blue) button as shown in Figure 1.
Figure 1: Joget Login screen
Figure 2: Login Page using Okta IDP
Upon successfully login in Okta with your registered email you would be redirected back to Joget.
Create App Integration
Figure 3: Okta Developer Dashboard - Creating App Integration
Figure 4: App Integration - SAML 2.0
In Joget, navigate to System Settings > Directory Manager Settings and select the SAML Service Provider Directory Manager as seen in Figure 7.
Figure 7: Select Plugin
Once selected, you should be directed to the next screen in Figure 8. If not, please click on Configure Plugin.
Figure 8: Plugin Configuration
Copy the Entity ID.
Go back to Okta page, and paste the value into:-
- Single sign-on URL
- Audience URI (SP Entity ID)
ss
sssss
ssss
Paste the content into Metadata in Joget.
Figure 11: Paste Metadata into Joget SAML Plugin
ss
Open the certificate with your text editor and copy the value and paste it into Joget.
Figure 14: Paste the Cert Content into Joget SAML Plugin
You may want to check on User Provisioning Enabled so that if it is the first time an user SSO into Joget, an user account would be created in Joget and the user would be able to continue to log in to Joget.
Figure 13: Configure User Attributes
Configure User Attributes based on the mappings below.
| Name | Value |
|---|---|
First Name Attribute | firstName |
Last Name Attribute | lastName |
Email Attribute |
The "Value" here corresponds with "Name" column that we have declared in Figure 8 earlier.
Up to this point, we have successfully created app integration in Okta and configured the SAML plugin in Joget.
No users from Okta are able to log in using this mechanism yet. Continue to read on.
Add Users to App Integration
We will need to assign user(s) to the app. Navigate to Applications > Assignments > Assign.
Figure 14: Assign Users to App
Once assigned, the selected users are now abe to SSO into Joget using their identity in Okta.