Contents

SAML Single Sign On (SSO) into Jenkins using JumpCloud As IDP

Jenkins SAML SSO app gives the ability to enable SAML Single Sign-On (SSO) for Jenkins. Here we will go through a guide to configure Single Sign On (SSO) between Jenkins and JumpCloud. By the end of this guide, JumpCloud users should be able to log in and register to Jenkins.

Pre-requisites

To integrate your Identity Provider (IDP) with Jenkins, you need the following items:

Jenkins should be installed and configured.
Jenkins Server is https enabled (optional).
Admin credentials are set up in Jenkins.

Download And Installation

SSO SAML Jenkins single sign on manage jenkins, Jenkins SAML SSO

Go to Manage Jenkins option from the left pane, and open Manage Plugins tab.

SSO SAML Jenkins single sign onmanage plugins, Jenkins SAML SSO

Search for Miniorange saml in the available tab.

SSO SAML Jenkins single sign onupload plugin, Jenkins SAML SSO

Download and install with a restart.

SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO

Step 1: Setup JumpCloud as Identity Provider

SAML Single Sign-On (SSO) using JumpCloud (IdP),login page

Go to SSO tab and click on + icon given on the page for adding a new SSO app.

SAML Single Sign-On (SSO) using JumpCloud (IdP), new SSO

Click on the Custom SAML App button.

SAML Single Sign-On (SSO) using JumpCloud (IdP), Custom App

On the New Application page, provide a name and description (optional) for your app and then go to the SSO tab.

Import through SP metadata file

Download SP Metadata file from SP Information tab of the plugin.

SAML Single Sign-On (SSO) using JumpCloud (IdP), JumpCloud Download MetaData

On the JumpCloud New Application page, in the field IdP Entity ID, enter a unique value of your choice.
Now, click on the Upload Metadata button and upload the SP Metadata file.

SAML Single Sign-On (SSO) using JumpCloud (IdP), SP Info

Manual configuration

Enter details manually from the SP Information tab.

Fields to be filled in JumpCloud	Corresponding details to be copied from the plugin
IdP Entity ID	Enter a unique IdP Entity ID of your choice
SP Entity ID	SP Entity ID/ Issuer
ACS URL	ACS URL
SP Certificate	Certificate (Download the file and upload here)

Step 1.2: Attribute Mapping

Scroll down to the Attributes section and click the add attribute button.
In the left-side input field provide Attribute Name to be sent in SAML assertion and, select the appropriate attribute value from the dropdown given on the right side.
For example, below we have provided userName as attribute and selected username from the dropdown. Similarly add all the attributes you wish to provision to service provider.

SAML Single Sign-On (SSO) using JumpCloud (IdP), Attribute Mapping

Step 1.3: Group Mapping

In the Group Attributes section enable the checkbox and provide the group attribute name.

SAML Single Sign-On (SSO) using JumpCloud (IdP), Group Mapping

Go to the User Groups tab. Here you can select which groups will have access to this SSO app. This is an important step to allow users to perform SSO with JumpCloud.

Click on the activate button given at the bottom and then click on Continue in the confirmation dialog box.
On the SSO page, select the checkbox given in front of the newly created application and click on the export metadata button. IDP metadata file will be downloaded.

SAML Single Sign-On (SSO) using JumpCloud (IdP), Export Metadata

Step 2: Setup Jenkins as Service Provider

Open Manage Jenkins and select Configure Global Security.

SSO SAML Jenkins single sign on configure security, Jenkins SAML SSO

Set the Security Realm as miniorange SAML 2.0 and click on save button.

SSO SAML Jenkins single sign on security realm, Jenkins SAML SSO

Make sure that Enable Security checkbox is checked.
Choose miniorange SAML SSO from the manage Jenkins tab.

Free
Premium

Free

SP Configurations
You can configure SP settings in IDP in 2 ways:

A. By uploading Metadata XML file

Click on Service Provider Metadata in SP Configuration section.
Metadata xml file will be downloaded.
Use this file to setup IDP.

B. Manual Configuration

To Configure SP Settings at IDP copy below URL and paste in respective fields at IDP end.

SP Entity ID: https://your-jenkins-domain
Audience URI: https://your-jenkins-domain
ACS URL: https://your-jenkins-domain/securityRealm/moSamlAuth

sso saml jenkins single sign on SP Configuration Jenkins

IDP Configuration

To Configure IDP enter the following details and press apply and save the settings.

IDP Entity ID
Single Sign On URL
Name ID Format
X.509 Certificate

sso saml jenkins single sign on idp Configuration Jenkins

You can either enter the metadata URL or the metadata file path.

User Profile Configuration

Select Username Case Conversion.
Enter the attribute name from IDP which corresponds to Username in Username Attribute textbox.
Enter the attribute name from IDP which corresponds to Email in Email Attribute textbox.
Select the checkbox Apply regex Pattern to the UserNameif the userID returned from SAML is not same as username of Jenkins.
Enter the regular expression in REGEX Pattern textbox. It will be applied on user ID from SAML Response and will convert it into the username same as Jenkins. For example, you can use regular expression ^.*?(?=@) to extract demo from username demo@example.com

Advanced Configurations

Select the SSO Binding Type.
Select the Create new user after SSO? to allow user creation through SAML.
Select Force Authentication.
To Add custom Attributes select Add option.

Set Attribute Name as the one set in IDP eg. lname
Set display name in user proprties as one you want it appear in jenkins user's config.xml file and in user's configure tab.

sso saml jenkins single sign on Advanced Configuration Jenkins

Premium

SP Configurations
You can configure SP settings in IDP in 2 ways:

A. By uploading Metadata XML file

Click on Service Provider Metadata in SP Configuration section.
Metadata xml file will be downloaded.
Use this file to setup IDP.

B. Manual Configuration

To Configure SP Settings at IDP copy below URL and paste in respective fields at IDP end.

SP Entity ID: https://your-jenkins-domain
Audience URI: https://your-jenkins-domain
ACS URL: https://your-jenkins-domain/securityRealm/moSamlAuth

IDP Configuration

To Configure IDP enter the following details and press apply and save the settings.

IDP Entity ID
Single Sign On URL
Single Logout URL
Name ID Format
X.509 Certificate

You can either enter the metadata URL or the metadata file path.

User Profile Configuration

Select Username or Email for Login Jenkins account by:
Select Username Case Conversion.
Enter the attribute name from IDP which corresponds to Username in Username Attribute textbox.
Enter the attribute name from IDP which corresponds to Email in Email Attribute textbox.
Enter the attribute name from IDP which corresponds to full name in Full Name Attribute.
Select the checkbox Apply regex Pattern to the UserNameif the userID returned from SAML is not same as username of Jenkins.
Enter the regular expression in REGEX Pattern textbox. It will be applied on user ID from SAML Response and will convert it into the username same as Jenkins. For example, you can use regular expression ^.*?(?=@) to extract demo from username demo@example.com

Advanced Configurations

Select the SSO Binding Type.
Select the SLO Binding Type.
Select the Send Signed Request ? to send signed login and logout requests. Requests will be signed using public certificate from option Download SP Certificate in SP Configuration section.
Select the Create new user after SSO? to allow user creation through SAML.
Select Force Authentication.
Select the Update Attributes of Existing Users ? to update attributes of existing user's each time they sign in Jenkins through SSO.
To Add custom Attributes select Add option.

Set Attribute Name as the one set in IDP eg. lname
Set display name in user proprties as one you want it appear in jenkins user's config.xml file and in user's configure tab.

To assign default group to users created through SSO add group name in Assign group to new Users option. Multiple groups can be added using ,(Comma) separater
You can assign groups from IDP to users created through SSO by adding the name of the group attribute that contains the IDP groups in the SAML response in the Group Attribute field in the plugin configuration. You can find out the group attribute name by performing the test configuration from the test configuration button under the I will do manual configuration tab.
If Disable Default login option is enabled, any unauthenticated user trying to access the default Jenkins login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the Jenkins base URL.
Copy backdoor URL and save it for emergency.

Additional Resources

Free Trial

If you don't find what you are looking for, please contact us at support-atlassian@miniorange.atlassian.net or raise a support ticket here.