Personalization Rehab: From cringe to conversion | Save your spot!
Contentstack
Changelog

Set up SSO with Microsoft Entra ID Native App

This step-by-step guide explains how to set up Single Sign-On in Contentstack with Microsoft Entra ID as your SAML 2.0 Identity Provider (IdP).

The integration with Microsoft Entra ID Native App can be done in the following easy steps:

  1. Create SSO Name and ACS URL in Contentstack
  2. Configure Contentstack App in Microsoft Entra ID
  3. Configure Microsoft Entra ID details in Contentstack
  4. Add Users to Your Microsoft Entra ID Application
  5. Add Users Roles in Your Application
  6. Assign Roles to Application Users for IdP Role Mapping
  7. Create Role Mappings in Contentstack
  8. Test and Enable SSO

Let us see each of the processes in detail.

  1. Create SSO Name and ACS URL in Contentstack

    Note: Only the Organization Owner will be able to perform the steps discussed below.

    Start by creating an SSO Name and generate the ACS URL in Contentstack

    1. Log in to your Contentstack account, go to the Organization Settings page, and click the Single Sign-On tab.
    2. Enter an SSO Name of your choice, and click Create. This name will be used as one of the login credentials by the organization users while signing in.

      Note: The SSO Name can contain only alphabets (in lowercase), numbers (0-9), and/or hyphens (-).

    3. When you click Create, this will generate the Assertion Consumer Service (ACS) URL and other details such as Entity ID, SAML Version, Attributes, and NameID Format.

      These details will be used in the upcoming Step 2 for configuring the Contentstack app in Microsoft Entra ID.

    Keep this window open, as you may need these details for setting up the Contentstack app in Entra ID.

  2. Configure Contentstack App in Microsoft Entra ID

    Note: You need to be a Microsoft Entra ID administrator to complete the steps below.

    To configure the integration of Contentstack into Microsoft Entra ID, you need to add the Contentstack app in the Microsoft Entra ID portal.

    1. Go to the Microsoft Azure portal, and click Microsoft Entra ID.

      Note: Please make sure you have an active subscription of Microsoft Entra ID before we proceed to the next step.

    2. Click Enterprise applications from the left panel.
    3. Click + New application from the top to create a new application.
    4. Go to the search box and search for the Contentstack application, and then click the Contentstack app icon that appears.
    5. You may provide a name to your application, for example, “Contentstack SSO” and click Create.
    6. This will lead you to the Overview page where you will see the overview details of your application. Under the Getting Started section, click the 2. Set up single sign on card.
    7. On the Single sign-on page, under Select a single sign-on method, select the SAML mode to enable single sign-on.
    8. You will be led to the Set up Single Sign-On with SAML page where you can perform further steps after creating your app.
    9. Click the “Edit” (pencil) icon beside the Basic SAML Configuration section, and add the following details:
      1. Identifier (Entity ID): Enter the “Entity ID” of Contentstack, i.e., https://app.contentstack.com.
      2. Reply URL (Assertion Consumer Service URL): Enter the ACS URL that we generated in Step 1.c.
    10. Click Save.

      Now in the Attributes & Claims section, you can view default or pre-set claims and their corresponding values.

      Amongst the listed attributes above, the attributes email, first_name, last_name, and roles are mandatory, while all other attributes are optional.

      NameValue
      first_nameuser.givenname
      last_nameuser.surname
      emailuser.userprincipalname
      rolesuser.assignedroles

      Note: If you want to enable Role Mapping in Contentstack, then it is highly important to add the already set roles attributes as we need these for IdP Role Mapping, which we will cover in the next set of steps.

    11. In the SAML Certificates section, click the Download link beside Certificate (Base64). This will download and save the Base64 version of the certificate for your Contentstack app.
    12. If needed, edit the Notification Email Addresses section, change the notification email, and click Save.
    13. Under the Set up <app_name> section, you will find important data, such as Login URL, Entra ID Identifier, and Logout URL of your Microsoft Entra ID app. This data is required when configuring the Microsoft Entra ID details in Contentstack.

  3. Configure Microsoft Entra ID details in Contentstack

    1. From the previous section, copy the URL provided in the Login URL section of your Contentstack application in Microsoft Entra ID and paste it into the Single Sign-On URL field in Contentstack’s 2 IdP configuration section.
    2. Upload the X.509 certificate that you downloaded from Microsoft Entra ID in Step 2.i. into the Certificate field in Contentstack SSO Settings.

    Next, you need to define roles in Microsoft Entra ID that would be used to create role mapping in Contentstack.

  4. Add Users to Your Microsoft Entra ID Application

    After setting the necessary configurations in Contentstack, you need to add users to your newly added application.

    To do so, you need to perform the following steps:

    1. Navigate to Microsoft Azure Portal > Entra ID application, select Enterprise Applications, select All applications, then select your application.
    2. Under the Getting Started section, click the 1. Assign users and groups tab.
    3. Click the + Add user/group button.
    4. Click Users and groups. You will find a list of users whom you can add into your application.

    You can either select from the given list of users or you can invite and add new users by inviting them.

  5. Add Users Roles in Your Application

    Note: This is an optional step, but it”s mandatory if IdP Role Mapping is part of your Contentstack plan and you want to implement it.

    Application Roles are defined under the application's registration manifest in the Microsoft Azure portal. To add user roles, perform the following steps:

    1. In the left navigation, click App Registrations, and then click All applications. Locate your newly created application and click it.
    2. In your application blade, click Manifest. You will see the JSON representation of your application.

      Add the following code snippet of a new role under appRoles:

      {

 "allowedMemberTypes": [

      "User"

     ],

     "description": "Developer Role",

     "displayName": "Developer",

     "id": "18d14569-c3bd-439b-9a66-3a2aee02f15f",

     "isEnabled": true,

     "value": "developer"

}

      The above code snippet is for adding a single role where the value provided to the value parameter is what you need to add in the IdP Role Mapping section of Contentstack. All the values provided in this snippet is user-defined.

      For adding multiple roles, create similar snippets with the required role details. You can add multiple such IdP roles and add their mappings in Contentstack.

    3. Save the manifest.

    You will be able to see all the roles that you created when you assign them to your application users.

  6. Assign Roles to Application Users for IdP Role Mapping

    Note: This is an optional step, but it is mandatory if IdP Role Mapping is part of your Contentstack plan and you want to implement it.

    This is an alternate way of managing users and permissions of your SSO-enabled organization. Performing this step lets you map your IdP roles to Contentstack roles while configuring SSO for your Contentstack organization.

    To assign roles to application users, perform the following steps:

    1. Navigate to Azure Entra ID application, select Enterprise Applications, select All applications, then select your application.
    2. Under the Getting Started section, click the 1. Assign users and groups tab.
    3. To add a new user with a role, click the + Add User button.
    4. Click Users and groups. You will find a list of users whom you can add into your application.
    5. Next, click Select Role in the Add Assignment page of your application. In the Select Role panel on the right, you will see the role you created (in our case, developer).
    6. Assign the selected role to the application user.

    You can now proceed to create role mappings in Contentstack for the IdP roles you created. Go to the User Management section of your Contentstack SSO settings.

  7. Create Role Mappings in Contentstack

    Note: You will only be able to view and perform this step if IdP Role Mapping is part of your Contentstack plan.

    In the User Management section of Contentstack's SSO Setup page, you will see Strict Mode (authorize access to organization users only via SSO login) and Session Timeout (define session duration for a user signed in through SSO).

    Below these options, you will see the Advanced Settings option.

    Click it to expand the IdP Role Mapping section to map IdP roles to Contentstack.

    1. In the Add Role Mapping section, click the + ADD ROLE MAPPING link to add the mapping details of an IdP role. The details include the following:
      1. IdP Role Identifier: Enter the IdP group/role identifier, for example, “developers.” You can use the value from your manifest.
      2. Organization Role: Assign either the ADMIN or MEMBER role to the mapped group/role.
      3. Stack Roles (optional): Assign stacks as well as the corresponding stack-level roles to this role.

      Likewise, you can add more role mappings for your Contentstack organization. To add a new Role mapping, click + ADD ROLE MAPPING and enter the details.

    2. Keep Role Delimiter blank as Microsoft Azure AD usually returns roles in an array.
    3. Finally, check the Enable IdP Role Mapping checkbox to enable the feature.
    4. Click Next to continue further.

    While some details about these steps are given below, you can refer to our general SSO guide for more information.

  8. Test and Enable SSO

    Next, you can try out the “Test SSO” and “Enable SSO” steps in Contentstack.

    Test SSO

    Before enabling SSO, it is recommended that you test the SSO settings configured so far.

    To do so, perform the following steps:

    1. Click the Test SSO button and it will take you to Contentstack’s Login Via SSO page where you need to specify your organization SSO name.
    2. Then, click Continue to go to your IdP sign in page.
    3. Sign in to your account. If you are able to sign in to your IdP, your test is successful.

      On successful connection, you will see a success message as follows:

      If you have enabled IdP Role Mapping, you’ll find the following details in a new page:

      • SSO connection established successfully - A success message is displayed.
      • IdP roles received - The list of all the roles assigned to you in your IdP.
      • Contentstack-IdP role mapping details - The details of all the Contentstack Organization-specific and Stack-specific roles mapped to your IdP roles.
    4. Click the Close button. Now, you can safely enable SSO for your organization.

    Note: While testing SSO settings with IdP Role Mapping enabled, the test will be performed only for the IdP roles of the currently logged-in user (i.e., the Owner performing the test).

    Enable SSO

    1. Once you have tested your SSO settings, click Enable SSO to enable SSO for your Contentstack organization.
    2. Confirm your action by clicking Yes.

    Once this is enabled, users of this organization can access the organization through SSO. If needed, you can always disable SSO from this page as well.

More articles in "SSO Guides"