Edit

Tutorial: Microsoft Entra SSO integration with Terraform Enterprise

  • Article

In this tutorial, you'll learn how to integrate Terraform Enterprise with Microsoft Entra ID. When you integrate Terraform Enterprise with Microsoft Entra ID, you can:

  • Control in Microsoft Entra ID who has access to Terraform Enterprise.
  • Enable your users to be automatically signed-in to Terraform Enterprise with their Microsoft Entra accounts.
  • Manage your accounts in one central location.

Prerequisites

To get started, you need the following items:

  • A Microsoft Entra subscription. If you don't have a subscription, you can get a free account.
  • Terraform Enterprise single sign-on (SSO) enabled subscription.

Scenario description

In this tutorial, you configure and test Microsoft Entra SSO in a test environment.

  • Terraform Enterprise supports SP initiated SSO.
  • Terraform Enterprise supports Just In Time user provisioning.

To configure the integration of Terraform Enterprise into Microsoft Entra ID, you need to add Terraform Enterprise from the gallery to your list of managed SaaS apps.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
  2. Browse to Identity > Applications > Enterprise applications > New application.
  3. In the Add from the gallery section, type Terraform Enterprise in the search box.
  4. Select Terraform Enterprise from results panel and then add the app. Wait a few seconds while the app is added to your tenant.

Alternatively, you can also use the Enterprise App Configuration Wizard. In this wizard, you can add an application to your tenant, add users/groups to the app, assign roles, as well as walk through the SSO configuration as well. Learn more about Microsoft 365 wizards.

Configure and test Microsoft Entra SSO for Terraform Enterprise

Configure and test Microsoft Entra SSO with Terraform Enterprise using a test user called B.Simon. For SSO to work, you need to establish a link relationship between a Microsoft Entra user and the related user in Terraform Enterprise.

To configure and test Microsoft Entra SSO with Terraform Enterprise, complete the following building blocks:

  1. Configure Microsoft Entra SSO - to enable your users to use this feature.
  2. Configure Terraform Enterprise SSO - to configure the single sign-on settings on application side.
  3. Test SSO - to verify whether the configuration works.

Configure Microsoft Entra SSO

Follow these steps to enable Microsoft Entra SSO.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > Enterprise applications > Terraform Enterprise > Single sign-on.

  3. On the Select a single sign-on method page, select SAML.

  4. On the Set up single sign-on with SAML page, click the pencil icon for Basic SAML Configuration to edit the settings.

    Edit Basic SAML Configuration

  5. On the Basic SAML Configuration section, enter the values for the following fields:

    a. In the Identifier (Entity ID) text box, type a URL using the following pattern: https://<TFE HOSTNAME>/users/saml/metadata

    b. In the Reply URL text box, type a URL using the following pattern: https://<TFE HOSTNAME>/users/saml/auth

    c. In the Sign on URL text box, type a URL using the following pattern: https://<TFE HOSTNAME>/

    Note

    These values are not real. Update these values with the actual Identifier, Reply URL and Sign on URL. Contact Terraform Enterprise Client support team to get these values. You can also refer to the patterns shown in the Basic SAML Configuration section.

  6. On the Set up single sign-on with SAML page, in the SAML Signing Certificate section, find Certificate (Base64) and select Download to download the certificate and save it on your computer.

    The Certificate download link

  7. On the Set up Terraform Enterprise section, copy the appropriate URL(s) based on your requirement.

    Copy configuration URLs

Create a Microsoft Entra test user

In this section, you'll create a test user called B.Simon.

  1. Sign in to the Microsoft Entra admin center as at least a User Administrator.
  2. Browse to Identity > Users > All users.
  3. Select New user > Create new user, at the top of the screen.
  4. In the User properties, follow these steps:
    1. In the Display name field, enter B.Simon.
    2. In the User principal name field, enter the username@companydomain.extension. For example, B.Simon@contoso.com.
    3. Select the Show password check box, and then write down the value that's displayed in the Password box.
    4. Select Review + create.
  5. Select Create.

Assign the Microsoft Entra test user

In this section, you'll enable B.Simon to use single sign-on by granting access to Terraform Enterprise.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
  2. Browse to Identity > Applications > Enterprise applications > Terraform Enterprise.
  3. In the app's overview page, select Users and groups.
  4. Select Add user/group, then select Users and groups in the Add Assignment dialog.
    1. In the Users and groups dialog, select B.Simon from the Users list, then click the Select button at the bottom of the screen.
    2. If you are expecting a role to be assigned to the users, you can select it from the Select a role dropdown. If no role has been set up for this app, you see "Default Access" role selected.
    3. In the Add Assignment dialog, click the Assign button.

Configure Terraform Enterprise SSO

Navigate to https://<TFE_HOSTNAME>/app/admin/saml and perform the following steps in the SAML Settings page:

Screenshot: Terraform Enterprise SAML Settings

a. Enable the Enable SAML single sign-on check box.

b. In the Single Sign-On URL textbox, paste the Login URL value which you copied.

c. In the Single Log-out URL textbox, paste the Login URL value which you copied.

d. Open the downloaded Certificate into Notepad and paste the content into the IDP CERTIFICATE textbox.

Create Terraform Enterprise test user

In this section, a user called B.Simon is created in Terraform Enterprise. Terraform Enterprise supports just-in-time user provisioning, which is enabled by default. There is no action item for you in this section. If a user doesn't already exist in Terraform Enterprise, a new one is created after authentication.

Test SSO

In this section, you test your Microsoft Entra single sign-on configuration with following options.

  • Click on Test this application, this will redirect to Terraform Enterprise Sign-on URL where you can initiate the login flow.

  • Go to Terraform Enterprise Sign-on URL directly and initiate the login flow from there.

  • You can use Microsoft My Apps. When you click the Terraform Enterprise tile in the My Apps, this will redirect to Terraform Enterprise Sign-on URL. For more information about the My Apps, see Introduction to the My Apps.

Next steps

Once you configure Terraform Enterprise you can enforce session control, which protects exfiltration and infiltration of your organization’s sensitive data in real time. Session control extends from Conditional Access. Learn how to enforce session control with Microsoft Defender for Cloud Apps.