Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

131 lines
5.4 KiB
Markdown
Raw Permalink Normal View History

2019-08-23 14:22:47 -07:00
---
title_tag: Configuring Azure Active Directory | SAML SSO
meta_desc: This page provides a walkthrough important aspects of configuring
Azure Active Directory (Azure AD) as a SAML SSO identity provider (IDP).
title: Azure AD
h1: "SAML: Configuring Azure Active Directory"
2023-06-08 16:15:52 -07:00
meta_image: /images/docs/meta-images/docs-meta.png
menu:
pulumicloud:
parent: saml
weight: 2
2019-08-23 14:22:47 -07:00
aliases:
- /docs/reference/service/saml-aad/
- /docs/console/accounts/saml/aad/
- /docs/guides/saml/aad/
2019-08-23 14:22:47 -07:00
---
This guide walks you through configuring your Azure Active Directory (Azure AD) as a SAML SSO identity provider
2023-04-11 13:40:50 -07:00
(IDP) for the Pulumi Cloud.
2019-08-23 14:22:47 -07:00
## Prerequisites
2019-08-23 14:22:47 -07:00
- [Single Sign-On](/docs/pulumi-cloud/access-management/saml/sso/)
## Configuring Azure AD
### Add an application to your Azure AD tenant
2019-08-23 14:22:47 -07:00
2022-04-29 17:09:22 -05:00
1. In the Azure portal, on the left navigation panel, select **Azure Active Directory**.
2019-08-23 14:22:47 -07:00
2022-04-29 17:09:22 -05:00
1. Select **Enterprise applications**. It will show some of the existing applications in your Azure
2019-08-23 14:22:47 -07:00
AD tenant.
![Enterprise applications section](/images/docs/reference/service/saml-aad/enterprise-applications.png)
2022-04-29 17:09:22 -05:00
1. Select **New application**.
2019-08-23 14:22:47 -07:00
![New application](/images/docs/reference/service/saml-aad/new-application.png)
1. Select **Non-gallery application** tile and in the **Add your own application** panel, enter
2023-04-11 13:40:50 -07:00
_Pulumi Cloud_ as the application name then select **Add**.
2019-08-23 14:22:47 -07:00
![Non-gallery application](/images/docs/reference/service/saml-aad/non-gallery-application.png)
2023-04-11 13:40:50 -07:00
1. In the new _Pulumi Cloud_ application, navigate to the **Single sign-on** section, and
2019-08-23 14:22:47 -07:00
select **SAML**.
![Single sign-on settings](/images/docs/reference/service/saml-aad/single-sign-on.png)
2022-04-29 17:09:22 -05:00
1. Select the **Edit** icon on the **Basic SAML Configuration** panel.
2019-08-23 14:22:47 -07:00
![SAML configuration](/images/docs/reference/service/saml-aad/saml-configuration.png)
### Enter Pulumi configuration into your Azure AD application
{{< saml-warning >}}
2019-08-23 14:22:47 -07:00
| SAML Setting | Value |
| --------------- | ----- |
| Identifier (Entity ID) | `https://api.pulumi.com/login/<acmecorp>/sso/saml/metadata` |
| Reply URL | `https://api.pulumi.com/login/<acmecorp>/sso/saml/acs` |
| Relay State | `https://api.pulumi.com/login/<acmecorp>/sso` |
2019-08-23 14:22:47 -07:00
![Edited SAML configuration](/images/docs/reference/service/saml-aad/edited-saml-configuration.png)
### Configure the name identifier format
2019-08-23 14:22:47 -07:00
2022-04-29 17:09:22 -05:00
1. Select the **Edit** icon on the **User Attributes & Claims** panel.
2019-08-23 14:22:47 -07:00
2022-04-29 17:09:22 -05:00
![User Attributes & Claims Panel](/images/docs/reference/service/saml-aad/attributes-and-claims-panel.png)
2019-08-23 14:22:47 -07:00
2022-04-29 17:09:22 -05:00
1. Then, select the **Edit** icon next to **Name identifier value**.
2019-08-23 14:22:47 -07:00
2022-04-29 17:09:22 -05:00
![User Attributes & Claims](/images/docs/reference/service/saml-aad/attributes-and-claims.png)
2019-08-23 14:22:47 -07:00
1. In the **Manage User Claims** panel, expand **Choose name identifier format** and select **Email address**.
2019-08-23 14:22:47 -07:00
2022-04-29 17:09:22 -05:00
![Manage Name Identifier Format](/images/docs/reference/service/saml-aad/name-identifier-format.png)
2019-08-23 14:22:47 -07:00
2022-04-29 17:09:22 -05:00
1. Finally, select **Save** at the bottom of the **Manage User Claims** panel.
2019-08-23 14:22:47 -07:00
> **Important:** Do not change the value of Name ID Format value once your users have started using Pulumi---not even switching its value between Email or Persistent.
<br />
2023-04-11 13:40:50 -07:00
> **Note:** Be sure to assign users and groups to use your new _Pulumi Cloud_ SAML application.
> That is how you can control membership access to your Pulumi organization. See the
2019-08-23 14:22:47 -07:00
> [Azure AD documentation](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-non-gallery-applications#assign-users-and-groups-to-your-saml-application)
> for more information.
Now that the Azure AD-side of the SAML SSO configuration is complete, you will need
2023-04-11 13:40:50 -07:00
to configure the Pulumi Cloud to receive SAML SSO requests from your
Azure AD.
2019-08-23 14:22:47 -07:00
## Configuring Your Pulumi Organization
To configure your Pulumi organization to accept SAML SSO requests from Azure AD, you will need to
download the SAML application's configuration data and then pass that to Pulumi.
2022-04-29 17:09:22 -05:00
1. Back on the Azure AD's application settings page, select the **SAML Signing Certificate** panel.
Then select **Download** next to **Federated Metadata XML** and save the resulting file.
2019-08-23 14:22:47 -07:00
![Download XML](/images/docs/reference/service/saml-aad/download-xml.png)
2023-04-11 13:40:50 -07:00
1. Sign into the Pulumi Cloud and navigate to your SAML organization. Navigate to the
2022-04-29 17:09:22 -05:00
**Settings** tab and then select **Access Management**.
2022-04-29 17:09:22 -05:00
1. Select the **Change Requirements** button and then **SAML SSO**.
2019-08-23 14:22:47 -07:00
1. Open up the XML document you downloaded from the Azure AD portal, and paste its full contents
into the **Identity Provider Metadata** field.
![Provide the XML IDP descriptor](/images/docs/reference/service/saml-aad/pulumi-saml-settings-page.png)
2022-04-29 17:09:22 -05:00
1. Select **Save**.
2019-08-23 14:22:47 -07:00
## Signing into Pulumi using Azure AD
Once your Azure AD application is created, and its configuration data passed to Pulumi, you can now
2023-04-11 13:40:50 -07:00
sign in to the Pulumi Cloud using your SAML SSO credentials.
2019-08-23 14:22:47 -07:00
Navigate to [https://app.pulumi.com/signin/sso/](https://app.pulumi.com/signin/sso/) and enter the
name of your Pulumi organization. If everything is configured correctly, you should be prompted to
2023-04-11 13:40:50 -07:00
sign in to your Azure AD instance, and then immediately be redirected back to the Pulumi Cloud.
2019-08-23 14:22:47 -07:00
2023-04-11 13:40:50 -07:00
![Pulumi Cloud](/images/docs/reference/service/saml-aad/pulumi-console-signin.png)
2019-08-23 14:22:47 -07:00
## Troubleshooting
If you have any trouble configuring Azure AD, signing into Pulumi, or need additional assistance, please
[contact support](https://support.pulumi.com/).