SAML Single Sign On (SSO) into Jenkins using Salesforce

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 Salesforce. By the end of this guide, Salesforce 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



  • Login to your Jenkins Admin Account.
    • SSO SAML Jenkins single sign on manage jenkins, Jenkins SAML SSO, Jenkins okta integration
  • Go to Manage Jenkins option from the left pane, and open Plugins tab.
    • Jenkins saml plugin, Jenkins sso aws,Jenkins saml okta, Jenkins sso azure ad
  • Search for SAML Single Sign On (SSO) in the available plugins 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 SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO
  • After restarting Jenkins, navigate to Manage Jenkins and select Security.
    • SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO
  • Under the Security Realm dropdown, choose miniOrange SAML 2.0, then click the Save button.
    • SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO
  • Once saved, click on miniOrange SAML SSO under the Security section and go to the Plugin settings.
    • SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO

Step 1: Setup Salesforce as Identity Provider

      • Log into your Salesforce account.
      • Switch to Salesforce Classic mode from profile menu and then go to the Setup page.
      • From the left pane, select Security ControlsIdentity Provider.
      • In the Service Provider section, click on the link to create the Service Provider using Connected Apps.
        • SAML Single Sign on (SSO) using Salesforce Identity Provider, Create SP via connected apps

      • Enter Connected App Name, API Name and Contact Email.
        • SAML Single Sign on (SSO) using Salesforce Identity Provider, Fill connected apps details

      • Under the Web App Settings, check the Enable SAML checkbox and enter the following values:
        • Entity ID SP-EntityID / Issuer from Service Provider Info Tab
        ACS URL ACS (AssertionConsumerService) URL from Service Provider Info Tab
        Subject Type Username
        Name ID Format urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
      • Now from the left pane, under Administer section, go to Manage AppsConnected Apps. Click on the app you just created.
      • Under Profiles section click Manage Profiles button and select the profiles you want to give access to log in through this app.
      • Under SAML Login Information, click on Download Metadata.
      • Keep this metadata handy for the next steps.
        • SAML Single Sign on (SSO) using Salesforce Identity Provider, Download Identity Providers metadata

Step 2: Setup Jenkins as Service Provider

  • Open Manage Jenkins and select Security.
    • SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO
  • Under the Security Realm dropdown, choose miniOrange SAML 2.0, then click the Save button.
    • SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO
  • Make sure that Enable Security checkbox is checked.
  • Choose miniOrange SAML SSO from the manage Jenkins tab.
    • SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO

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

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


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
      • 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
  • You can either enter the metadata URL or the metadata file path.
    • sso saml jenkins single sign on idp Configuration Jenkins

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


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


Step 3: Manage permissions/Groups

  • Click on the Group Configuration tab from the left panel.
    • Jenkins SAML Single Sign On (SSO)

      Jenkins SAML Single Sign On (SSO) Sync groups from IDP

      • 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.
        • Jenkins SAML Single Sign On (SSO) Jenkins SAML Single Sign On (SSO)
      • To assign a default group to users created through SSO add the group name in the Assign group to new Users option. Multiple groups can be added using a comma (,) separator.
      • Group Mapping allows you to align user groups from your identity provider (IdP) with the corresponding groups in Jenkins. This is especially useful when the group names in your IDP differ from those in Jenkins. By configuring group mappings, you can ensure that users are assigned the correct roles and permissions within Jenkins based on their IdP group membership.

        For example, if your IdP group is named "idpGroupName" but the corresponding group in Jenkins is "jenkinsGroup", you can map idpGroupName to jenkinsGroup to maintain consistent access control.

        • Jenkins Single Sign On (SSO)

        Jenkins SAML Single Sign On (SSO) Sync groups from crowd

        • To Assign groups from the crowd just enter your crowd instance url and crowd application name and password as shown below.
        • You can refer to this guide to add a jenkins application to your crowd instance.
        • If you want to update user details or want to fetch groups or nested groups check the options accordingly.
          • Jenkins SAML Single Sign On (SSO)


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.