SAML single sign-on

6 minute readSecurity

Security Assertion Markup Language (SAML) is a standard for exchanging authentication and authorization data between an identity provider (IdP) and a service provider. SAML is a common single sign-on (SSO) configuration that allows users to sign in to multiple software applications using the same credentials. CloudBees Feature Management uses the SAML 2.0 protocol to implement SSO.

CloudBees Feature Management SAML authentication is service provider (SP)-initiated. CloudBees Feature Management integrates with an IdP provider by linking a CloudBees Feature Management user with an IdP user. The connection is made using the SAML’s NameIdFormat, which is required. The default Active Directory setting usually does not include NameIdFormat, so you may have to add it manually.

CloudBees Feature Management SAML supports the following IdPs:

  • Okta

  • Onelogin

  • Active Directory Federation Services (ADFS)

Enabling and configuring SAML

You must be an organization administrator to enable SAML.

CloudBees Feature Management SAML provides a streamlined user experience, as it lets you sign in to CloudBees Feature Management with your existing credentials from another system.

To enable SAML in CloudBees Feature Management:

  1. Go to the upper-right corner of the CloudBees Feature Management Home page, and select your email and avatar.

  2. Select the organization where you want to enable SAML. If you are a member of only one organization, disregard this step.

  3. Select Organization management.

  4. Select the toggle next to Disabled.

  5. Enter your Organization login prefix. Choose a name with alphanumeric characters and hyphens only.

  6. Configure your IdP. Refer to instructions specific for your IdP for more information. In general:

    1. Enter the CloudBees Feature Management endpoint URL https://app.rollout.io/login/<organization-login-prefix>/callback in your IdP configuration, substituting your Organization login prefix for <organization-login-prefix>. The endpoint URL is also known as the assertion consumer service (ACS) URL or the single sign on URL.

    2. Enter the CloudBees Feature Management Organization login prefix into your IdP configuration. This is also known as the SP entity ID or the audience URI.

      The Organization login prefix must be entered into the IdP configuration exactly as it appears in CloudBees Feature Management. The IdP configuration is case-sensitive.
      Example of IdP configuration
      Figure 1. Example of IdP configuration
    3. Copy the Identity Provider metadata from your IdP. You may need to select a link to the IdP metadata in your IdP configuration to access the XML file.

  7. In your CloudBees Feature Management organization, enter the IdP metadata by pasting in the XML file contents.

  8. You can select the checkbox to enable SAML Strict Mode. Refer to Enabling and disabling SAML Strict Mode for more information.

  9. Select Update.

SAML is enabled for your CloudBees Feature Management organization and Enabled is listed next to the toggle. You are now ready to connect user accounts with SAML.

Connecting users via SAML

A user must first be invited to CloudBees Feature Management in order to use SAML. If SAML is disabled, users can sign in to CloudBees Feature Management using their email and password.

After enabling SAML in your organization, existing users must connect SAML within their CloudBees Feature Management account in order to sign in via SAML. For more information, refer to Connecting and reconnecting existing user accounts via SAML. New users are connected via SAML through their invitation email. For more information, refer to Connecting invited users via SAML.

Checking if users are connected via SAML

After enabling SAML, you may need to check if all existing users are connected via SAML.

To check if a user is connected via SAML:

  1. Go to the upper-right corner of the CloudBees Feature Management Home page, select your email and avatar, and then select Account.

  2. Below the user email is SAML status. The SAML status displays Connected if the user is connected and Please authenticate with your IdP if the user is not connected.

    SAML status
    Figure 2. SAML status

If the SAML status is not showing below the user email, SAML is not enabled for the organization.

Connecting invited users via SAML

Invited users are those who have received an email invitation but have yet to join CloudBees Feature Management.

Users who are invited when the SAML configuration is disabled must select Join in the invitation email to join the CloudBees Feature Management organization, and then connect SAML within CloudBees Feature Management.

Users who are invited when the SAML configuration is enabled must select Login in the invitation email to complete their SAML connection to the CloudBees Feature Management organization.

If the invited user did not receive their invitation, or the SAML IdP metadata has changed, organization administrators can resend the invitation email. This is especially useful if SAML Strict Mode is enabled.

To resend a SAML invitation email:

  1. Go to the upper-right corner of the CloudBees Feature Management Home page, and select your email and avatar.

  2. Select the organization where SAML is enabled. If you are a member of only one organization, disregard this step.

  3. Select Organization management.

  4. Select the user.

  5. Select Resend SAML invite.

  6. Select Close.

The user receives an email invitation to sign in to CloudBees Feature Management using SAML.

Connecting and reconnecting existing user accounts via SAML

Existing users have accounts listed on the Organization management screen.

To connect or reconnect existing organization accounts via SAML:

  1. Go to the upper-right corner of the CloudBees Feature Management Home page, select your email and avatar, and then select Account.

  2. To the right of SAML status, select Connect SAML to connect (or Reconnect SAML to reconnect).

  3. On Connect to your IdP, select Ok to receive a password reset email, and then select Ok.

  4. Check your email inbox for the password reset email to complete your SAML configuration.

  5. Open the password reset email and select Login. You are taken back to CloudBees Feature Management through SAML.

The user account is connected via SAML, and the SAML status on Account has changed to Connected. The user can sign in to CloudBees Feature Management via their SAML credentials.

You may need to reconnect SAML for your CloudBees Feature Management account due to changes in the IdP configuration. For example, reconnection is required when:

  • NameIdFormat value is changed. This value is for a specific user, so only this user has to reconnect SAML.

  • NameIdFormat field is switched in the IdP. All accounts in the organization have to reconnect SAML.

  • IdP is switched. All user accounts in the organization have to reconnect SAML.

    SAML status
    Figure 3. Connected SAML status with Reconnect SAML highlighted

Enabling and disabling SAML Strict Mode

When SAML Strict Mode is enabled for an organization, all organization users who are not administrators must use SAML to sign in to that organization. Any existing CloudBees Feature Management sign-in credentials, including alternatives such as Google OAuth, are not valid. Organization administrators retain access to these alternatives.

Both the Organization login prefix and the IdP metadata fields must be valid to enable or disable SAML Strict Mode.

To enable/disable SAML Strict Mode:

  1. Go to the upper-right corner of the CloudBees Feature Management Home page, and select your email and avatar.

  2. Select the organization where you want to enable/disable SAML Strict Mode. If you are a member of only one organization, disregard this step.

  3. Select Organization management.

  4. Select Edit SAML settings.

  5. Next to SAML Strict Mode, select the checkbox to enable, and clear the checkbox to disable.

  6. Select Update.

SAML Strict Mode is updated accordingly for your organization.

SAML configuration highlighting SAML Strict Mode option
Figure 4. SAML configuration highlighting SAML Strict Mode option

Signing in with SAML

Once your CloudBees Feature Management account is connected via SAML, you can sign in to CloudBees Feature Management with your SAML credentials.

With SAML Strict Mode enabled, all organization users who are not administrators must use SAML to sign in to CloudBees Feature Management. Any existing CloudBees Feature Management sign-in credentials, or alternatives such as Google OAuth, are not valid. Admins do retain access to alternative sign-in modes for troubleshooting purposes.

To sign on with SAML Strict Mode enabled, if you are not an organization administrator:

  • Go to app.rollout.io/login/<org prefix>, which then redirects to your IdP.

To sign on with SAML Strict Mode disabled, or if you are an organization administrator, select one of the following two options:

  • Go to app.rollout.io/login/<org prefix>, which then redirects to your IdP.

  • Use the CloudBees Feature Management sign-in screen. Note that this option is always available to organization administrators, regardless of SAML Strict Mode status.

    Organization users who are not administrators can use the CloudBees Feature Management sign-in screen only if **SAML Strict Mode** is disabled.
    Figure 5. Organization users who are not administrators can use the CloudBees Feature Management sign-in screen only if SAML Strict Mode is disabled.

Editing SAML settings

You can change your SAML settings if you are an organization administrator.

To edit SAML settings:

  1. Go to the upper-right corner of the CloudBees Feature Management Home page, and select your email and avatar.

  2. Select the organization where you want to edit SAML. If you are a member of only one organization, disregard this step.

  3. Select Organization management.

  4. Select Edit SAML settings to update the Organization login prefix, the IdP metadata, and/or SAML Strict Mode.

  5. Select Update.

Your SAML settings are updated.

Disabling SAML

You can disable SAML for your CloudBees Feature Management organization. Your SAML settings are saved in CloudBees Feature Management if you want to enable SAML in future.

To disable SAML:

  1. Go to the upper-right corner of the CloudBees Feature Management Home page, select your email and avatar, and then select the organization where you want to disable SAML. Disregard this step if you are a member of only one organization.

  2. Select Organization management.

  3. Select the toggle next to Enabled.

SAML is disabled for your CloudBees Feature Management organization and Disabled is listed next to the toggle. Your SAML settings are saved for future use.