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


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

Step 1: Setup WSO2 as Identity Provider

  • Login to your WSO2 admin console.
  • Select Add under the Service Providers tab.
  • Select mode as Manual Configuration.
  • Enter the Service Provider Name and click on Register button.
  • SAML Single Sign On (SSO) using WSO2 as Identity Provider, Add Service Provider Manually
  • Select Upload SP certificate option under SP Certificate Type.
  • Copy the certificate from plugin and provide it into Application Certificate field.
  • You can also download the certificate file and upload it through Browse file option.
  • SAML Single Sign On (SSO) using WSO2 as Identity Provider, Add Service Provider Manually
  • Under Claim Configuration, select Use Local Claim Dialect.
  • For Requested Claims, add http://wso2.org/claims/emailaddress as a claim URI.
  • Set Subject Claim URI to http://wso2.org/claims/nickname.
  • Under Inbound Authentication Configuration > SAML2 Web SSO Configuration, click Configure.
  • SAML Single Sign On (SSO) using WSO2 as Identity Provider, Claim Configuration
  • Enter Issuer value as provided under the Service Provider Info tab of the plugin.
  • Enter Assertion Consumer URL (ACS) as provided under Service Provider Info tab and click on Add.
  • Check Enable Response Signing.
  • Check the Enable Attribute Profile and include attributes in the response always.
  • SAML Single Sign On (SSO) using WSO2 as Identity Provider, Configuring Service Providers Meta Details
  • Check the Enable Audience Restriction.
  • Enter the Audience URL value provided under Service Provider Info tab of plugin and click on Add.
  • Check the Enable Recipient Validation. Enter the Recipient URL value provided under Service Provider Info tab of plugin and click on Add.
  • Click on Download IDP Metadata button save the IDP metadata file.
  • Click on Register to save the configuration.
  • SAML Single Sign On (SSO) using WSO2 as Identity Provider, Enable Audience validation and Download IDP Metadata File
  • Click on Update on Service Providers page to save the configuration.
  • Select Resident under Identity Providers tab from the menu.
  • Enter Home Realm Identifier value that you want (usually your WSO2 server address).
  • SAML Single Sign On (SSO) using WSO2 as Identity Provider, Set Home Realm Identifier URL
  • Click on Update to save the changes.

Step 2: Download and install the plugin in Jenkins.

    To Setup the miniorange saml SP plugin follow the path:

  • Login to your Jenkins Admin Account.
  • sso saml jenkins single sign on manage jenkins-1
  • Go to Manage Jenkins option from the left pane, and open Manage Plugins tab.
  •  sso saml jenkins single sign onmanage plugins-2
  • Go to the advanced tab and upload the hpi file.
  •  sso saml jenkins single sign onupload plugin-3
  • Follow the instructions shown on screen and restart the Jenkins.
  • sso saml jenkins single sign on install plugins-4

Step 3: Activate the plugin

  • Open Manage Jenkins and select Configure Global Security.
  • sso saml jenkins single sign on configure security-5
  • Set the Security Realm as miniorange SAML 2.0.
  • sso saml jenkins single sign on security realm-6
  • Make sure that Enable Security checkbox is checked.
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 -6

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
  • sso saml jenkins single sign on User Profile Jenkins


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


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
  • 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
  • sso saml jenkins single sign on User Profile Jenkins


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.
  • sso saml jenkins single sign on Advanced Configuration Jenkins




Our Other Apps: SAML SSO Apps | OAuth Apps | 2FA Apps | Crowd Apps | REST API Apps | Kerberos/NTLM Apps | User Sync Apps |
                             Bitbucket Git Authentication App

If you are looking for anything which you cannot find, please drop us an email on info@xecurify.com