diff --git a/assets/images/lambdatest-sso-google/3.png b/assets/images/lambdatest-sso-google/3.png new file mode 100644 index 00000000..eb8c55d7 Binary files /dev/null and b/assets/images/lambdatest-sso-google/3.png differ diff --git a/assets/images/lambdatest-sso-google/add-custom-saml-app.png b/assets/images/lambdatest-sso-google/add-custom-saml-app.png new file mode 100644 index 00000000..39dec2e7 Binary files /dev/null and b/assets/images/lambdatest-sso-google/add-custom-saml-app.png differ diff --git a/assets/images/lambdatest-sso-google/app-detail-google.png b/assets/images/lambdatest-sso-google/app-detail-google.png new file mode 100644 index 00000000..27b4ac5c Binary files /dev/null and b/assets/images/lambdatest-sso-google/app-detail-google.png differ diff --git a/assets/images/lambdatest-sso-google/app-not-enabled.png b/assets/images/lambdatest-sso-google/app-not-enabled.png new file mode 100644 index 00000000..e970e707 Binary files /dev/null and b/assets/images/lambdatest-sso-google/app-not-enabled.png differ diff --git a/assets/images/lambdatest-sso-google/attribute-mapping.png b/assets/images/lambdatest-sso-google/attribute-mapping.png new file mode 100644 index 00000000..fadf40c6 Binary files /dev/null and b/assets/images/lambdatest-sso-google/attribute-mapping.png differ diff --git a/assets/images/lambdatest-sso-google/certificate-upload.png b/assets/images/lambdatest-sso-google/certificate-upload.png new file mode 100644 index 00000000..74f7f0f6 Binary files /dev/null and b/assets/images/lambdatest-sso-google/certificate-upload.png differ diff --git a/assets/images/lambdatest-sso-google/configure-idp.png b/assets/images/lambdatest-sso-google/configure-idp.png new file mode 100644 index 00000000..db8513d1 Binary files /dev/null and b/assets/images/lambdatest-sso-google/configure-idp.png differ diff --git a/assets/images/lambdatest-sso-google/custom-app-creation.png b/assets/images/lambdatest-sso-google/custom-app-creation.png new file mode 100644 index 00000000..d6d99c4c Binary files /dev/null and b/assets/images/lambdatest-sso-google/custom-app-creation.png differ diff --git a/assets/images/lambdatest-sso-google/idp-selector.png b/assets/images/lambdatest-sso-google/idp-selector.png new file mode 100644 index 00000000..1a9a50d4 Binary files /dev/null and b/assets/images/lambdatest-sso-google/idp-selector.png differ diff --git a/assets/images/lambdatest-sso-google/service-provider-detail.png b/assets/images/lambdatest-sso-google/service-provider-detail.png new file mode 100644 index 00000000..7498e8d5 Binary files /dev/null and b/assets/images/lambdatest-sso-google/service-provider-detail.png differ diff --git a/assets/images/lambdatest-sso-google/sp-details.png b/assets/images/lambdatest-sso-google/sp-details.png new file mode 100644 index 00000000..42db7460 Binary files /dev/null and b/assets/images/lambdatest-sso-google/sp-details.png differ diff --git a/assets/images/lambdatest-sso-google/sp-initiated-sso.png b/assets/images/lambdatest-sso-google/sp-initiated-sso.png new file mode 100644 index 00000000..9d74af41 Binary files /dev/null and b/assets/images/lambdatest-sso-google/sp-initiated-sso.png differ diff --git a/assets/images/lambdatest-sso-google/sso-setup-lambdatest.png b/assets/images/lambdatest-sso-google/sso-setup-lambdatest.png new file mode 100644 index 00000000..af7f239e Binary files /dev/null and b/assets/images/lambdatest-sso-google/sso-setup-lambdatest.png differ diff --git a/assets/images/lambdatest-sso-google/update-app-for-user-access.png b/assets/images/lambdatest-sso-google/update-app-for-user-access.png new file mode 100644 index 00000000..5e2ddc60 Binary files /dev/null and b/assets/images/lambdatest-sso-google/update-app-for-user-access.png differ diff --git a/assets/images/lambdatest-sso-google/user-created-in-lambdatest.png b/assets/images/lambdatest-sso-google/user-created-in-lambdatest.png new file mode 100644 index 00000000..613c7a9b Binary files /dev/null and b/assets/images/lambdatest-sso-google/user-created-in-lambdatest.png differ diff --git a/docs/lambdatest-sso-google.md b/docs/lambdatest-sso-google.md new file mode 100644 index 00000000..bc2c0583 --- /dev/null +++ b/docs/lambdatest-sso-google.md @@ -0,0 +1,263 @@ +--- +id: lambdatest-sso-google +title: LambdaTest SSO & Google Custom Using SAML +hide_title: true +sidebar_label: Google +description: Now integrate your Google Workspace user directory with your LambdaTest organization subscription through an IDP, so that your team could leverage the SSO setup. +keywords: + - sso + - lambdatest sso + - google custom + - google workspace + - saml + - lambdatest google integration + - lambdatest google sso +url: https://www.lambdatest.com/support/docs/lambdatest-sso-google/ +site_name: LambdaTest +slug: lambdatest-sso-google/ +--- + + + +# LambdaTest SSO Integration with Google Workspace + +* * * + +LambdaTest provides seamless Single Sign-On (SSO) integration with Google Workspace, enabling your team to access LambdaTest using their existing Google credentials. This integration streamlines user management and enhances security by centralizing authentication through your Google Workspace identity provider. + +This comprehensive guide will walk you through configuring SAML-based SSO between your LambdaTest organization and Google Workspace, ensuring a smooth and secure authentication experience for your team. + +## Prerequisites + +* * * + +Before configuring SSO integration, ensure you have the following: + +* **LambdaTest Enterprise Plan**: SSO functionality is available with our Enterprise subscription. Learn more about [managing your subscription](/docs/manage-subscriptions/). +* **LambdaTest Organization Admin Access**: You must have administrative privileges within your LambdaTest organization to configure SSO settings. +* **Google Workspace Super Admin Access**: Administrative access to your organization's Google Workspace instance is required to create and configure SAML applications. + +## Configuration Guide + +* * * + +The SSO integration process involves configuring both Google Workspace and LambdaTest. We'll guide you through each step to ensure a successful setup. + +### Step 1: Create SAML App in Google Workspace + +1. **Access Google Admin Console**: Sign in to the [Google Admin Console](https://admin.google.com/) using a super administrator account. This level of access is required to create and configure SAML applications. + +2. **Navigate to Web and Mobile Apps**: In the Google Admin Console, navigate to **Menu** > **Apps** > **Web and mobile apps** to access the application management section. + +3. **Add Custom SAML App**: Click **Add App** and select **Add custom SAML app** to create a new SAML application for LambdaTest integration. + +Navigate to Web and Mobile Apps + + +4. **Configure Application Details**: + - **App name**: Enter a descriptive name such as "LambdaTest SSO" or "LambdaTest Integration" to easily identify this application in your Google Workspace admin console. + - Click **Continue** to proceed to the next configuration step. + + + + +Add custom SAML app + +5. **Retrieve Google Identity Provider Details**: On the **Google Identity Provider details** page, you'll need to collect the following information for LambdaTest configuration: + + - **SSO URL**: Copy this URL - LambdaTest will use this endpoint to initiate authentication requests + - **Entity ID**: Copy this unique identifier - this serves as Google's identity in the SAML exchange + - **Certificate**: Download the X.509 certificate file in PEM format - LambdaTest will use this to verify Google's SAML responses + + **Important**: Keep this information secure and readily accessible, as you'll need to enter these details in LambdaTest's SSO configuration. + + Click **Continue** to proceed. + + LambdaTest Configuration Details + + +### Step 2: Create Connection in LambdaTest + +6. **Access LambdaTest SSO Configuration**: Navigate to the [LambdaTest Authentication & SSO settings](https://accounts.lambdatest.com/auth/sso) page. This dashboard provides comprehensive management of your organization's single sign-on configuration. Click **Setup SSO** to initiate the integration process. + +7. **Create New SSO Connection**: In the connection setup wizard, enter a descriptive connection name such as "Google Workspace SSO" or "LambdaTest Google Integration". This name will help you identify and manage this connection in your LambdaTest organization. Click **Add New Connection** to proceed. + +LambdaTest SSO Settings + +8. **Select Identity Provider**: From the list of supported identity providers, select **Other SAML Provider** to configure Google Workspace integration. + +Select Other SAML Provider + +9. **Retrieve LambdaTest Configuration Details**: LambdaTest will generate and display the configuration details required for your Google Workspace setup. These critical details include: + - **Assertion Consumer Service (ACS) URL**: The secure endpoint where Google will send SAML authentication responses + - **Entity ID**: LambdaTest's unique identifier in the SAML exchange protocol + - **X.509 Certificate**: LambdaTest's public certificate for verifying SAML response authenticity + + **Important**: Securely copy these details as you'll need to enter them in your Google Workspace admin console to complete the integration. + +LambdaTest Configuration Details + +Click **Continue** to proceed to the next step. + +10. **Review Attribute Mapping Requirements**: LambdaTest displays the user attributes that must be mapped from your Google Workspace directory. The essential attributes for proper user provisioning include: + - **Email Address**: User's primary email address for account identification + - **First Name**: User's given name for personalization + - **Last Name**: User's surname for complete user profiles + - **Display Name**: User's full display name (optional but recommended) + + **Note**: Document these attribute requirements as you'll need to configure the corresponding mappings in Google Workspace. Click **Continue** after reviewing the requirements. + +### Step 3: Complete Google Workspace Configuration + +11. **Return to Google Workspace Configuration**: Navigate back to the Google Admin Console tab where you were configuring the SAML application. + +12. **Configure Service Provider Details**: In the **Service Provider Details** window, enter the LambdaTest configuration details you copied in step 9: + - **ACS URL**: Paste the Assertion Consumer Service URL from LambdaTest. This secure endpoint will receive SAML authentication responses from Google. + - **Entity ID**: Enter LambdaTest's Entity ID. This unique identifier enables Google to recognize LambdaTest in the SAML exchange. + - **Start URL**: (Optional) Leave blank or enter your LambdaTest organization URL for direct user redirection after authentication. + - **Name ID Format**: Set to **"X509_SUBJECT"** - this specifies the format for the Name ID attribute + - **Name ID**: Set to **"Basic Information > Primary Email"** - this serves as the primary user identifier + +Configure Service Provider Details + + + +13. **Configure Attribute Mapping**: Click **Add mapping** to establish the user attribute mappings required by LambdaTest: + - **Google Directory attributes**: Select the appropriate field from the Google directory attributes dropdown + - **App attributes**: Enter the corresponding attribute name that LambdaTest expects + + Configure the following essential mappings: + - **Primary Email**: Map to `email` + - **First Name**: Map to `given_name` + - **Last Name**: Map to `family_name` + + + Configure Attribute Mapping + +14. **Complete Google Workspace Setup**: Click **Finish** to finalize the SAML application configuration in Google Workspace. + +Enter app details + +15. **Enable SAML Application**: In the Google Admin Console, navigate to **Menu** > **Apps** > **Web and mobile apps**, locate the LambdaTest SAML application you created, click **User access**, then configure access for your organization: + - **On for everyone**: Enable access for all users in your organization + - **On for some organizations**: Enable access for specific organizational units + - **On for some groups**: Enable access for specific groups of users + - **Off for everyone**: Disable access (not recommended for production) + + Select your preferred access level and click **Save** to activate the application. + +Turn On SAML App + +### Step 4: Complete LambdaTest Integration + +16. **Return to LambdaTest Configuration**: Navigate back to the LambdaTest SSO configuration page to complete the integration by providing Google Workspace details. + +17. **Provide Google Workspace Configuration**: Enter the Google Workspace SAML configuration details you collected earlier: + - **Sign-in URL**: Enter the SSO URL copied from Google Workspace in [step 5](#step-1-create-saml-app-in-google-workspace) + - **Certificate**: Upload the X.509 certificate file (PEM format) downloaded from Google Workspace in [step 5](#step-1-create-saml-app-in-google-workspace) + - **Entity ID**: Enter the Entity ID copied from Google Workspace in [step 5](#step-1-create-saml-app-in-google-workspace) + +18. **Configure SSO Domain Restrictions**: Specify the email domains that are authorized to authenticate through this SSO connection: + - `yourcompany.com` - enables authentication for all users with @yourcompany.com email addresses + - `subsidiary.com,partner.com` - supports multiple domains (comma-separated) + +Upload Google Certificate and SSO URL + +19. **Pre-Integration Verification**: Before finalizing the connection, ensure the following: + - All required configuration fields are properly completed + - The X.509 certificate file has been successfully uploaded and validated + - SSO URL and Entity ID values are accurately entered + - SSO domain restrictions align with your organization's email domains + - Configuration details are consistent between Google Workspace and LambdaTest + +20. **Finalize SSO Integration**: After verification, click **Create Connection** to complete the SSO integration and activate the authentication flow. + +## SSO Verification and Testing + +* * * + +After completing the integration, verify that your SSO setup is functioning correctly by testing both authentication flows. + +### Identity Provider-Initiated (IdP) SSO Testing + +1. **Access Test Functionality**: In the Google Admin Console, navigate to **Menu** > **Apps** > **Web and mobile apps**. +2. **Select LambdaTest Application**: Locate and select the LambdaTest SAML application you configured. +3. **Execute Test Login**: Click **Test SAML login** in the top-left corner of the application details page. +4. **Verify Successful Redirect**: LambdaTest should open in a new browser tab. If the test fails, review the SAML error messages and update your configuration accordingly, then retest. + +### Service Provider-Initiated (SP) SSO Testing + +1. **Access LambdaTest SSO**: Navigate to [https://accounts.lambdatest.com/sso](https://accounts.lambdatest.com/sso) to access the LambdaTest SSO login page. +2. **Enter Email Address**: Enter your Google Workspace email address in the email field. +3. **Initiate SSO**: Click **CONTINUE WITH SSO** to begin the authentication process. +4. **Complete Authentication**: You'll be redirected to Google's sign-in page. Enter your Google Workspace credentials. +5. **Verify Successful Authentication**: After successful authentication, you should be automatically redirected to your LambdaTest organization. + +LambdaTest SSO Login Page + +## Troubleshooting Common Issues + +* * * + +If you encounter issues with your SSO integration, the following troubleshooting guide will help you resolve common problems: + +### Application Not Enabled Error + +If you receive an "App not enabled" error, the SAML application hasn't been properly activated for your users in Google Workspace. + +App Not Enabled Error + +**Resolution**: Return to the Google Admin Console, navigate to your SAML application, and ensure it's enabled for the appropriate users or organizational units. + +### Common Configuration Issues + +1. **Certificate Mismatch**: Verify that the X.509 certificate uploaded to LambdaTest exactly matches the certificate from Google Workspace +2. **URL Configuration**: Ensure the ACS URL and Entity ID are accurately copied between both platforms +3. **Attribute Mapping**: Confirm that attribute names match precisely between Google Workspace and LambdaTest +4. **Domain Restrictions**: Verify that SSO domains in LambdaTest correspond to your organization's email domains +5. **User Permissions**: Ensure users have appropriate access to the SAML application in Google Workspace + + +> **Integration Complete!** Your LambdaTest organization is now successfully integrated with Google Workspace SSO. Your team can now access LambdaTest using their Google Workspace credentials. If you encounter any issues or need assistance, our window.openLTChatWidget()}>**Support Team** is here to help. You can also reach us at [support@lambdatest.com](mailto:support@lambdatest.com). Happy Testing! + + diff --git a/sidebars.js b/sidebars.js index 5f2c81e8..b6bf142f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -3959,6 +3959,11 @@ module.exports = { label: "OneLogin Integration", id: "lambdatest-sso-onelogin-using-saml", }, + { + type: "doc", + label: "Google Custom Integration", + id: "lambdatest-sso-google", + }, { type: "doc", label: "Azure AD",