SAML Single Sign On (SSO) into Jenkins using Auth0 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 Auth0. By the end of this guide, Auth0 users should be able to log in and register to Jenkins.

Step 1: Setup Auth0 as Identity Provider

Single Sign On(SSO) using Auth0, Auth0 SSO Login-1 Prerequisites:

Copy these values from the Service Provider Info tab of the SAML plugin.

SP Entity ID
ACS URL
Single Logout URL (If the user is logged out from the Atlassian application, he will be logged out from Auth0 as well.)

Single Sign On(SSO) using Auth0, Auth0 SSO Login-2 Instructions:

Log in to your Auth0 dashboard.
Click on Applications.

SAML Single Sign On (SSO) using Auth0 Identity Provider, add Application

Click on Create Application.

SAML Single Sign On (SSO) using Auth0 Identity Provider, Create Application

A new window will pop-up. Enter a name for the application and select Regular Web App. Click on CREATE button.

SAML Single Sign On (SSO) using Auth0 Identity Provider,Regular web app

Select the Addons tab.

SSAML Single Sign On (SSO) using Auth0 Identity Provider, Addons tab

Enable SAML2 option in the addons. It will open up a Configuration window.

SAML Single Sign On (SSO) using Auth0 Identity Provider, Enable SAML 2 Option for your App

Enter Application Callback URL, Audience, Recipient and other settings using SP entity ID and ACS URL copied from the plugin as shown below:

SAML Single Sign On (SSO) using Auth0 Identity Provider, application callback URL

Scroll down and click on Enable.

SAML Single Sign On (SSO) using Auth0 Identity Provider, Enable window

Go to the Usage tab and click on the Identity Provider Metadata download link. It will download the metadata XML file which you'll need for setting up the SAML plugin.

SAML Single Sign On (SSO) using Auth0 Identity Provider, Metadata tab

Single Sign On(SSO) using Auth0, Auth0 SSO Login-2 Create User:

Go to Users & RolesUsers from left pane.
Click on the Create User. Provide Email and Password for new user.
Click on the Create button.

Step 2: Download and install the plugin in Jenkins

Login to your Jenkins Admin Account.

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

Go to the advanced tab and upload the hpi file.

SSO SAML Jenkins single sign onupload plugin, Jenkins SAML SSO

Follow the instructions shown on screen and restart the Jenkins.

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

Step 3: Activate the plugin

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.

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

Make sure that Enable Security checkbox is checked.

Free
Premium

Free

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

By uploading Metadata XML file
Manual Configuration

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 metadata

User Profile Configuration

Select Username or Email for Login Jenkins account by:
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 Do you want to create a new users? to allow user creation through SAML.

sso saml jenkins single sign on Advanced Configuration Jenkins

Premium

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

By uploading Metadata XML file
Manual Configuration

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

sso saml jenkins single sign on idp Configuration Jenkins

User Profile Configuration

Select Username or Email for Login Jenkins account by:
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 Do you want signed requests? 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 Do you want to create a new users? to allow user creation through SAML.
Select the Do you want to 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
If Do you want to 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.

SAML Single Sign On (SSO) into Jenkins using Auth0 as IDP

Step 1: Setup Auth0 as Identity Provider

Step 2: Download and install the plugin in Jenkins

Step 3: Activate the plugin

Free

Premium

Contents

STAY CONNECTED

Product

Solutions

Why miniorange

Company