Single Sign-on: Microsoft Entra ID

The Microsoft Entra ID (previously Azure Active Directory) SSO integration currently supports the following SAML features:

• Service Provider (SP) initiated SSO
• Identity Provider (IdP) initiated SSO
• Just-in-Time Provisioning

For more information on the listed features, visit the Microsoft Entra ID SAML Protocol Documentation.

Configuration (Microsoft Entra ID)

1. Sign in to the Entra portal.
2. On the left navigation pane, select the Microsoft Entra ID service.
3. Navigate to Enterprise Applications and then select All Applications.
4. To add new application, select New application.
5. In the Add from the gallery section, type Terraform Cloud in the search box.
6. Select Terraform Cloud from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
7. On the Terraform Cloud application integration page, find the Manage section and select single sign-on.
8. On the Select a single sign-on method page, select SAML.
9. In the SAML Signing Certificate section (you may need to refresh the page) copy the App Federation Metadata Url.

Configuration (HCP Terraform)

1. Visit your organization settings page and click "SSO".

2. Click "Setup SSO".

   

3. Select "Microsoft Entra ID" and click "Next".

   

4. Provide your App Federation Metadata URL.

   

5. Save, and you should see a completed Terraform Cloud SAML configuration.

6. Copy Entity ID and Reply URL.

Configuration (Microsoft Entra ID)

1. In the Entra portal, on the Terraform Cloud application integration page, find the Manage section and select single sign-on.
2. On the Select a single sign-on method page, select SAML.
3. On the Set up single sign-on with SAML page, click the edit/pen icon for Basic SAML Configuration to edit the settings.
   1. In the Identifier text box, paste the Entity ID.
   2. In the Reply URL text box, paste the Reply URL.
   3. For Service Provider initiated SSO, type https://app.terraform.io/session in the Sign-On URL text box. Otherwise, leave the box blank.
   4. Select Save.
4. On the Single sign-on page, download the Certificate (Base64) file from under SAML Signing Certificate.
5. In the app's overview page, find the Manage section and select Users and groups.
6. Select Add user, then select Users and groups in the Add Assignment dialog.
7. In the Users and groups dialog, select your user from the Users list, then click the Select button at the bottom of the screen.
8. 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.
9. In the Add Assignment dialog, click the Assign button.

Configuration (HCP Terraform)

To edit your Entra SSO configuration settings:

1. Go to Public Certificate.

2. Paste the contents of the SAML Signing Certificate you downloaded from Microsoft Entra ID.

3. Save Settings.

4. Verify your settings and click "Enable".

5. Your Entra SSO configuration is complete and ready to use.

   

Team and Username Attributes

To configure team management in your Microsoft Entra ID application:

1. Navigate to the single sign-on page.
2. Edit step 2, User Attributes & Claims.
3. Add a new group claim.
4. In Group Claims, select Security Groups.
5. In the Source Attribute field, select either sAMAccountName to use account names or Group ID to use group UUIDs.
6. Check Customize the name of the group claim.
7. Set Name (required) to "MemberOf" and leave the namespace field blank.

If you plan to use SAML to set usernames in your Microsoft Entra ID application:

1. Navigate to the single sign-on page.
2. Edit step 2, User Attributes & Claims.
   We recommend naming the claim "username", leaving the namespace blank, and sourcing user.displayname or user.mailnickname as a starting point. If you have a Terraform Enterprise account, you can source user.mail or user.userprincipalname. Note that HCP Terraform usernames only allow lowercase letters, numbers, and dashes.

If you namespaced any of your claims, then Microsoft Entra ID passes the attribute name using the format <claim_namespace/claim_name>. Consider this format when setting team and username attribute names.

Troubleshooting the SAML assertion

Use this guide to verify and validate the claims being sent in the SAML response.