Google Workspace

This topic explains how to configure Google Workspace to support single sign-on (SSO) in LaunchDarkly.

Overview

This topic explains how to configure Google Workspace to support single sign-on (SSO) in LaunchDarkly.

The procedures in this topic explain how to configure SSO for Google Workspace. To learn how to configure Google OAuth instead, read Google OAuth.

If a member signs in to LaunchDarkly using Google OAuth, they cannot also sign in to the same account using Google Workspace SSO. Similarly, if you invite a member to join a LaunchDarkly account using Google Workspace SSO, they cannot also sign in using Google OAuth.

Prerequisites

To configure SSO for LaunchDarkly using Google Workspace, you must complete the following prerequisite:

• Configure SAML for authentication. For more information, read the Google knowledge base.

Use the table below to configure Google fields for LaunchDarkly:

Google field	LaunchDarkly setting
ACS URL	Use LaunchDarkly’s Assertion Consumer Service URL value.
Entity ID	Use LaunchDarkly’s Entity ID value.
Start URL	Use LaunchDarkly’s Start URL value.
Signed Response	Check this box.
Name ID	Select Basic Information and Primary Email .
Name ID Format	Select EMAIL .
Attribute Mapping	Enter role as the application attribute, and select the custom user attribute that corresponds to the desired role. You will map customRole and teamKey in a later step.

Configure SSO for Launch

Darkly with Google Workspace

Before you create the LaunchDarkly app in Google Workspace, you must create LaunchDarkly-specific fields for roles, custom roles, and teams.

To configure these fields:

1. Log into Google Workspace.
2. Navigate to your user directory by clicking Directory and then Users.
3. Click the Manage user attributes icon. A popup screen appears:

4. Select Add Custom Category.
5. Name the custom category whatever you like. The example below uses LaunchDarkly Attributes.
6. Add the role, customRole, and teamKey fields:

Set the Multiple values field for customRole and teamKey to “Yes.” Some account members may have more than one custom role or team, which requires multiple values.

Add Launch

Darkly as a custom SAML application

Next, you must add LaunchDarkly to your Google Workspace apps.

To add LaunchDarkly:

1. Log into Google Workspace.
2. Navigate to Apps, then SAML Apps.
3. Click the plus button to Add an app.
4. Select Setup my own Custom App to configure LaunchDarkly. The setup workflow initiates.
5. In step 2 of the workflow, copy the information from the setup workflow. You’ll need to add this into LaunchDarkly’s Security tab under Edit SAML Configuration:

6. In step 3, enter the name of the app.
7. In step 4 of the workflow, provide the Assertion consumer service URL, entity ID, and start URL for your LaunchDarkly account:

To find them, click Edit your SAML configuration on the LaunchDarkly Security tab:

8. In step 5, map the LaunchDarkly attributes firstName and lastName to Google’s “First Name” and “Last Name” basic information fields. Map the LaunchDarkly attributes role, customRole, and teamKey to Google’s “LaunchDarkly Attributes” fields of the same name. These mappings are shown below:

In the screenshot above, the names in the left-hand columns map to those present in LaunchDarkly. You must name them exactly as shown, including exact casing (role, customRole, and teamKey), or configuration will fail.

You’ve successfully connected LaunchDarkly to Google Workspace.

Assign roles, custom roles, and teams with Google Workspace

Now that the application is configured, you can assign roles and teams.

To assign roles and teams:

1. Log into Google Workspace.
2. Navigate to Directory, then Users.
3. Click on the Google Workspace user that you want to assign roles to and choose Account to bring up the user’s account settings.
4. Click Edit beneath “Manage user attributes” to add the user’s roles and teams to the corresponding attribute fields:

5. Click Update User.

The next time this user logs into LaunchDarkly through Google Workspace, their roles and teams will update. If this is a brand new LaunchDarkly account member, an account will be created automatically with the roles and teams you specified.

SAML ignores empty role, customRole, and teamKey fields. To clear all existing roles or teams, enter an empty string "" into the field.