SAML: Configuring Google Workspace

This guide walks you through configuring your Google Workspace (formerly known as G Suite) service as a SAML SSO identity provider (IDP) for the Pulumi Cloud.

Prerequisites

• Single Sign-On

Creating the SAML Application

1. In the administrator console for your Google Workspace domain, open the flyout menu in the upper-left corner and choose Apps > Web and mobile apps.

   

2. Select Add app > Add custom SAML app to create a new SAML application.

   

3. In the first step, give the SAML app a name (e.g., Pulumi-SSO), and optionally add an App Icon, and select Continue. Pulumi Logos has PNG logos available.

   

4. Next, choose Option 1: Download Metadata to download an XML document that identifies and describes your Google Workspace domain as a SAML identity provider. You will need this document to complete the process of configuring your Pulumi organization. For now, note the location of the downloaded file, then select Continue to continue.

   

5. In step 3, for the required ACS URL and Entity ID and Start URL fields, enter the fully-qualified URLs of the acs and metadata and sso endpoints of the Pulumi API, adjusted for your Pulumi organization name.

   If you're in an environment with no internet access, you may skip the Pulumi version update check by setting the environment variable PULUMI_SKIP_UPDATE_CHECK to 1 or true.

   SAML Setting	Value
   ACS URL	https://api.pulumi.com/login/<acmecorp>/sso/saml/acs
   Entity ID	https://api.pulumi.com/login/<acmecorp>/sso/saml/metadata
   Start URL	https://api.pulumi.com/login/<acmecorp>/sso
   Name ID Format	EMAIL or PERSISTENT

   

   Set Name ID format to EMAIL or PERSISTENT. Leave the other fields as their default values, then select Continue.

   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.

6. The final step—attribute mapping—is optional, but you may wish to specify proper first and last names for your Pulumi users, based on their Google account profiles. The Pulumi Cloud expects to receive these fields as firstName and lastName, respectively.

   Once you add them, select Finish.

   

7. On the next screen, enable your newly created SAML application for your Google domain users by selecting the down arrow in the User access panel:

   

   Select ON for everyone and Save.

   

   At this point, you’re done configuring Google Workspace, and can move on to completing SAML SSO setup in the Pulumi Cloud.

Configuring Your Pulumi Organization

The final step in the process consists of associating your Pulumi organization with your SSO identity provider.

1. Sign in to the Pulumi Cloud where your SAML organization resides, then navigate to the Settings tab for that organization.

2. Select Access Management and then Change requirements.

3. Select SAML SSO and Next

   

4. Paste the full contents of the XML IDP document you have previously downloaded into the text box.

   

5. Select Apply changes and refresh your browser page to see the SAML SSO settings.

Your Pulumi organization is now configured to use Google as a SAML SSO identity provider.

Signing in to Pulumi with Google

Members of your Google Workspace can now sign into Pulumi. Navigate to https://app.pulumi.com/signin/sso/ and enter the name of your Pulumi organization.

Troubleshooting

Google Workspace SAML troubleshooting page: SAML app error messages

If you need additional assistance, contact us.