2019-08-23 14:22:47 -07:00
---
2022-12-08 15:41:39 -08:00
title_tag: Configuring Google Workspace | SAML SSO
2019-12-18 09:59:20 -08:00
meta_desc: This page provides a walkthrough important aspects of configuring
2022-05-02 13:00:46 -05:00
Google Workspace as a SAML SSO identity provider (IDP).
2023-05-15 15:25:28 -07:00
title: Google Workspace
h1: "SAML: Configuring Google Workspace"
2023-06-08 16:15:52 -07:00
meta_image: /images/docs/meta-images/docs-meta.png
2019-09-11 15:55:11 -07:00
menu:
2023-05-15 15:25:28 -07:00
pulumicloud:
parent: saml
weight: 2
2019-09-11 15:55:11 -07:00
2019-08-23 14:22:47 -07:00
aliases:
- /docs/reference/service/saml-gsuite/
- /docs/console/accounts/saml/gsuite/
2023-05-15 15:25:28 -07:00
- /docs/guides/saml/gsuite/
2019-08-23 14:22:47 -07:00
---
2022-05-02 13:00:46 -05:00
This guide walks you through configuring your Google Workspace (formerly known as G Suite) service as a SAML SSO identity provider
2023-04-11 13:40:50 -07:00
(IDP) for the Pulumi Cloud.
2019-09-04 17:21:43 -07:00
## Prerequisites
2023-05-15 15:25:28 -07:00
- [Single Sign-On ](/docs/pulumi-cloud/access-management/saml/sso/ )
2019-08-23 14:22:47 -07:00
## Creating the SAML Application
2022-05-02 13:00:46 -05:00
1. In the [administrator console ](https://admin.google.com/ ) for your Google Workspace domain, open the flyout menu
in the upper-left corner and choose **Apps > Web and mobile apps** .
2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00

2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00
1. Select **Add app > Add custom SAML app** to create a new SAML application.
2019-08-23 14:22:47 -07:00

2023-05-15 15:25:28 -07:00
1. 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 ](/brand/ ) has PNG logos available.
2019-08-23 14:22:47 -07:00

2022-05-02 13:00:46 -05:00
1. 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
2019-08-23 14:22:47 -07:00
to complete the process of configuring your Pulumi organization. For now, note the location of
2022-05-02 13:00:46 -05:00
the downloaded file, then select **Continue** to continue.
2019-08-23 14:22:47 -07:00

2022-05-02 13:00:46 -05:00
1. 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.
2019-09-04 17:21:43 -07:00
{{< saml-warning > }}
| 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` |
2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00

2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00
Set `Name ID format` to *EMAIL* or *PERSISTENT* . Leave the other fields as their default values, then select **Continue** .
2019-09-04 17:21:43 -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`.
2019-08-23 14:22:47 -07:00
2019-09-04 17:21:43 -07:00
1. The final step---attribute mapping---is optional, but you may wish to specify proper
2023-04-11 13:40:50 -07:00
first and last names for your Pulumi users, based on their Google account profiles. The Pulumi Cloud
2019-09-04 17:21:43 -07:00
expects to receive these fields as `firstName` and `lastName` , respectively.
2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00
Once you add them, select **Finish** .
2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00

2019-08-23 14:22:47 -07:00
2019-09-04 17:21:43 -07:00
1. On the next screen, enable your newly created SAML application for your Google
2022-05-02 13:00:46 -05:00
domain users by selecting the down arrow in the **User access** panel:
2019-08-23 14:22:47 -07:00

2022-05-02 13:00:46 -05:00
Select **ON for everyone** and **Save** .

2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00
At this point, you're done configuring Google Workspace, and can move on to completing SAML SSO setup in
2023-04-11 13:40:50 -07:00
the Pulumi Cloud.
2019-08-23 14:22:47 -07:00
## Configuring Your Pulumi Organization
The final step in the process consists of associating your Pulumi organization with your SSO identity
provider.
2023-04-11 13:40:50 -07:00
1. Sign in to the Pulumi Cloud where your SAML organization resides, then navigate to the **Settings** tab for that
2019-08-23 14:22:47 -07:00
organization.
2022-05-02 13:00:46 -05:00
1. Select **Access Management** and then **Change requirements** .
2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00
1. Select **SAML SSO** and **Next**
2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00

2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00
1. Paste the full contents of the XML IDP document you have previously downloaded into the text box.

1. Select **Apply changes** and refresh your browser page to see the SAML SSO settings.
2019-08-23 14:22:47 -07:00
Your Pulumi organization is now configured to use Google as a SAML SSO identity provider.
2022-01-13 09:48:57 -08:00
## Signing in to Pulumi with Google
2019-08-23 14:22:47 -07:00
2022-05-02 13:00:46 -05:00
Members of your Google Workspace can now sign into Pulumi. Navigate to
2019-08-23 14:22:47 -07:00
[https://app.pulumi.com/signin/sso/ ](https://app.pulumi.com/signin/sso/ ) and enter the
name of your Pulumi organization.
2023-04-11 13:40:50 -07:00

2019-08-23 14:22:47 -07:00
## Troubleshooting
2022-05-02 13:00:46 -05:00
Google Workspace SAML troubleshooting page: [SAML app error messages ](https://support.google.com/a/answer/6301076 )
2022-10-26 07:22:15 -07:00
If you need additional assistance, [contact us ](/about#contact-us ).