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

Step 1: Setup Azure AD as Identity Provider

    Single Sign On using AzureAD, AzureAD SSO Login-1 Prerequisites:

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

    • SP Entity ID
    • ACS URL

    Single Sign On into AzureAD, AzureAD SSO Login-2 Instructions:

    Note: Enterprise app configuration is the recommended option for SAML . If you do not have Azure subscription or using free account please setup App Registration Configuration.

    To perform Single Logout using Azure AD, the Atlassian instance (E.g. Jira,Confluence) must be https enabled.

  • Log in to Azure AD Portal

  • Select ⇒ and Azure Active Directory ⇒ Enterprise Applications.

  • Azure AD SAML SSO enterprise application
  • Click on New Application.

  • Azure AD SAML SSO new application
  • Click on Non-gallery application section and enter the name for your app and click on Add button.

  • Azure AD SAML SSO Non gallery application
  • Click on Single sign-on from the application's left-hand navigation menu. The next screen presents the options for configuring single sign-on. Click on SAML.

  • Azure AD SAML SSO select saml
  • Edit the option 1 :Basic SAML Configuration to configure plugin endpoints.
  • Enter the SP Entity ID for Identifier and the ACS URL for Reply URL from Service Provider Info tab of the plugin.

  • Azure AD SAML SSO saml configuration
  • Click on Save icon.
  • Azure AD SAML SSO save window
  • By default, the following Attributes will be sent in the SAML token. You can view or edit the claims sent in the SAML token to the application under the User Attributes & Claims tab.
  • You can add attribute using Add new claim
  •  Azure AD SAML SSO user attributes claims
  • You can add group attribute claim using Add a group claim
  • Azure AD SAML SSO add a group claim
  • Copy App Federation Metadata Url from setup tab.

  • Azure AD SAML SSO federation metadata URL
  • Click on User and groups from the applications left-hand navigation menu. The next screen presents the options for assigning the users/groups to the application.

  • Azure AD SAML SSO user and groups
  • Log in to Azure AD Portal

  • Select Azure Active Directory ⇒ App Registrations. Click on New Application Registration.

  •  Azure AD SAML SSO New app
  • Assign a Name and choose the account type. In the Redirect URI field, provide the ACS URL provided in Service Provider Info tab of the plugin and click on Register button.
  •       Azure AD SAML SSO app registration
  • Now, navigate to Expose an API menu option and click the Set button and replace the APPLICATION ID URI with the plugin's SP Entity ID

  • Azure AD SAML SSO expose an API
  • By default, some Attributes will be sent in the SAML token. If you're not getting group information. Then, add Token configuration for Group information.

  • Azure AD SAML SSO token configuration
  • Click on Add groups claim
  • Azure AD SAML SSO Add groups claim
  • Go back to Azure Active Directory ⇒ App Registrations window and click on Endpoints link.

  • Azure AD SAML SSO Endpoints
  • This will open up a window with multiple URLs listed there. Copy the Federation Metadata Document URL. This will be required while configuring the SAML plugin.

  • Azure AD SAML SSO federation metadata document

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:

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:

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