> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Workspace self-serve SSO setup

> Configure SAML-based single sign-on between Google Workspace and CodeRabbit from your organization's account management page.

export const EnterprisePlanBadge = ({tip = "This feature is available exclusively as part of the Enterprise plan. Please refer to our pricing page for more information about our plans and features.", title = "Enterprise Plan", cta = "Read more", href = "https://coderabbit.ai/pricing", disabled = false}) => {
  return <Tooltip tip={tip} cta={cta} href={href}>
        <Badge icon="building-2" disabled={disabled || undefined}>
            {title}
        </Badge>
    </Tooltip>;
};

export const AdminRoleBadge = ({tip = "This feature requires an organization owner, an admin role or the corresponding permission. Regular Members do not have access.", title = "Admin Only", cta = "View roles", href = "/management/roles", disabled = false}) => {
  return <Tooltip tip={tip} cta={cta} href={href}>
        <Badge icon="lock" color="orange" disabled={disabled || undefined}>
            {title}
        </Badge>
    </Tooltip>;
};

<EnterprisePlanBadge />

<AdminRoleBadge tip="This page requires organization admin access. Members do not have access to Enterprise SSO settings." />

Use this guide to configure Google Workspace as the identity provider for your CodeRabbit Enterprise organization. The account management SSO wizard guides you through domain verification, Google Workspace SAML app setup, testing, and activation.

After SSO is activated, users with a verified email domain must sign in to CodeRabbit through Google Workspace.

## Before you start

Make sure you have:

* **Critical: You must have an invitation to your CodeRabbit organization from your CodeRabbit account team before starting this setup.**
* Organization admin access in the CodeRabbit account management page
* Access to the **Google Admin Console**
* Permission to create and configure custom SAML apps in Google Workspace
* Access to your DNS provider if your email domain still needs verification
* The users, groups, or organizational units that should be allowed to sign in through Google Workspace

<Info>
  If you do not see the **Security** section or the **Start configuration** button in your organization profile, contact your CodeRabbit account team. Your organization must be prepared for self-serve SSO before the account management SSO wizard appears.
</Info>

## Set up Google Workspace self-serve SSO

<Steps>
  <Step title="Open the account management SSO wizard">
    Accept your CodeRabbit organization invitation and sign in to the account management page. Open the organization switcher, find the invited organization, and click **Manage**.

    In the organization profile, select **Security**, and click **Start configuration**.
  </Step>

  <Step title="Add and verify your email domain">
    In **Domains**, enter the email domain that should use Google Workspace for CodeRabbit sign-in, then click **Add**.

    If the wizard asks you to add a DNS record, add the generated `TXT` record in your DNS provider and wait for the domain to show **Verified** before continuing.

    <Frame caption="Continue after the email domain shows Verified">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-domain-verified.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=15135b57ea663b73ffec93b1e9778a45" alt="Domain verification step showing the email domain verified" width="1750" height="1050" data-path="assets/images/google-self-serve-domain-verified.png" />
    </Frame>
  </Step>

  <Step title="Select Google Workspace">
    In **Connection**, select **Google Workspace** as the SAML identity provider.

    <Frame caption="Select Google Workspace as the identity provider">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-select-provider.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=81b6adf0d13717b0051fc4ab9e5caf3b" alt="Identity provider selection screen with the Google Workspace tile highlighted" width="1740" height="1120" data-path="assets/images/google-self-serve-select-provider.png" />
    </Frame>
  </Step>

  <Step title="Create the custom SAML app in Google Workspace">
    The account management SSO wizard lists the Google Admin Console steps you need to complete.

    <Frame caption="Review the Google Workspace app creation steps">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-setup-instructions.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=20967b22958851fede541696e7cbf9f2" alt="Account management SSO wizard showing Google Workspace custom SAML app creation steps" width="1746" height="980" data-path="assets/images/google-self-serve-setup-instructions.png" />
    </Frame>

    In the Google Admin Console, go to **Apps** -> **Web and mobile apps**, click **Add app**, then select **Add custom SAML app**.

    <Frame caption="Select Add custom SAML app in Google Admin Console">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-add-custom-saml-app.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=5555ff2620bb9885ee4f7c6a5fc2d7a1" alt="Google Admin Console Add app menu with Add custom SAML app highlighted" width="1050" height="690" data-path="assets/images/google-self-serve-add-custom-saml-app.png" />
    </Frame>

    In **App details**, enter a clear app name such as `CodeRabbit`. The description and icon are optional.

    <Frame caption="Enter a clear app name for the custom SAML app">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-app-details.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=cb0063c80ef1955fbde5cc693c20017b" alt="Google Admin Console custom SAML app details screen with a generic CodeRabbit app name" width="2300" height="1450" data-path="assets/images/google-self-serve-app-details.png" />
    </Frame>
  </Step>

  <Step title="Download and upload the IdP metadata">
    In the Google custom SAML app setup, download the Google IdP metadata.

    <Frame caption="Download the Google IdP metadata file">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-download-metadata.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=9b6e1593daca86394221c9320fb05d91" alt="Google Admin Console Google Identity Provider details screen with Download Metadata highlighted" width="2000" height="680" data-path="assets/images/google-self-serve-download-metadata.png" />
    </Frame>

    Return to the account management SSO wizard. In **Configure Google Workspace**, keep **Add via metadata** selected, upload the Google metadata XML file, and continue.

    <Frame caption="Upload the Google IdP metadata file">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-upload-metadata.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=97bdcba5a03cc01940fd7fe59613babe" alt="Account management SSO wizard showing the uploaded Google IdP metadata file" width="1750" height="1050" data-path="assets/images/google-self-serve-upload-metadata.png" />
    </Frame>
  </Step>

  <Step title="Configure service provider details">
    In the account management SSO wizard, copy the **ACS URL** and **Entity ID** values.

    <Frame caption="Copy the service provider values from the account management SSO wizard">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-sp-values.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=ef3e91f8077f2c8732c85bcd9907d18f" alt="Account management SSO wizard showing the ACS URL and Entity ID fields redacted" width="1746" height="1050" data-path="assets/images/google-self-serve-sp-values.png" />
    </Frame>

    In the Google custom SAML app setup, paste the values into the matching fields:

    | Google field    | Value                                                                   |
    | --------------- | ----------------------------------------------------------------------- |
    | ACS URL         | Copy from the account management SSO wizard                             |
    | Entity ID       | Copy from the account management SSO wizard                             |
    | Start URL       | Leave blank                                                             |
    | Signed response | Leave unchecked unless your CodeRabbit account team instructs otherwise |
    | Name ID format  | `EMAIL`                                                                 |
    | Name ID         | `Basic Information > Primary email`                                     |

    <Frame caption="Paste the CodeRabbit service provider values into Google Workspace">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-google-sp-details.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=a3a3dc29e9610be0e25a1b22f1818af7" alt="Google Admin Console service provider details screen with the ACS URL and Entity ID redacted" width="2200" height="1270" data-path="assets/images/google-self-serve-google-sp-details.png" />
    </Frame>
  </Step>

  <Step title="Map SAML attributes">
    The account management SSO wizard lists the attributes CodeRabbit expects from Google Workspace.

    <Frame caption="Review the required Google Workspace attribute mappings">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-attribute-values.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=c79cff94965d40454c96b001efb89c18" alt="Account management SSO wizard showing the expected Google Workspace SAML attributes" width="1750" height="1050" data-path="assets/images/google-self-serve-attribute-values.png" />
    </Frame>

    In the Google custom SAML app setup, add the following attribute mappings:

    | Google directory attribute | App attribute |
    | -------------------------- | ------------- |
    | `Primary email`            | `email`       |
    | `First name`               | `firstName`   |
    | `Last name`                | `lastName`    |

    <Frame caption="Add the required attribute mappings in Google Workspace">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-google-attribute-mapping.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=fe9badaf0834109e4d68210c0195dbd3" alt="Google Admin Console attribute mapping screen showing email, firstName, and lastName mappings" width="2200" height="1030" data-path="assets/images/google-self-serve-google-attribute-mapping.png" />
    </Frame>
  </Step>

  <Step title="Turn on the SAML app for users">
    After the custom SAML app is created, open its **Service status** settings and turn the app on for the users, groups, or organizational units that should be allowed to sign in to CodeRabbit.

    The example below shows **ON for everyone**. Use the access scope that matches your rollout plan.

    <Frame caption="Turn on service access for the users who should sign in through Google Workspace">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-service-status.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=efa886d01046420e2a841f12e974033a" alt="Google Admin Console service status screen with ON for everyone highlighted and organization names redacted" width="2380" height="860" data-path="assets/images/google-self-serve-service-status.png" />
    </Frame>
  </Step>

  <Step title="Test the SSO connection">
    In **Test**, click **Open test URL** and complete the Google Workspace sign-in flow with a user who has access to the custom SAML app and whose email matches your verified domain.

    Return to the account management SSO wizard and click **Refresh logs** until the latest test result shows **Success**. Do not activate SSO while the latest result is **Pending** or failed.

    <Frame caption="Confirm the SSO test result succeeds before activation">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-test-success.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=dc53c736edbadc185f0ad7dfa652b8f8" alt="Account management SSO wizard showing the Open test URL button and a successful test result with user details redacted" width="1746" height="1050" data-path="assets/images/google-self-serve-test-success.png" />
    </Frame>
  </Step>

  <Step title="Activate SSO">
    In **Activate**, review the activation message and click **Activate SSO**.

    <Warning>
      Activation changes sign-in behavior for the verified domain. After activation, users with that email domain must sign in to CodeRabbit through Google Workspace.
    </Warning>

    <Frame caption="Activate SSO after the connection test succeeds">
      <img src="https://mintcdn.com/coderabbit/GloY4hCsgvrKMG0G/assets/images/google-self-serve-activate.png?fit=max&auto=format&n=GloY4hCsgvrKMG0G&q=85&s=b09832112eb75ede905bfe8e8f92ebcd" alt="Account management SSO wizard with the Activate SSO button highlighted and the domain redacted" width="1748" height="1100" data-path="assets/images/google-self-serve-activate.png" />
    </Frame>
  </Step>
</Steps>

## What's next

<CardGroup cols={1}>
  <Card title="Enterprise SSO overview" href="/management/sso" icon="key" horizontal>
    Return to the SSO overview to understand how Enterprise SSO fits into your CodeRabbit rollout.
  </Card>

  <Card title="Roles and permissions" href="/management/roles" icon="shield-check" horizontal>
    Pair SSO with the right access controls by reviewing how roles work in your CodeRabbit organization.
  </Card>

  <Card title="Support" href="/support" icon="message-circle" horizontal>
    Contact CodeRabbit if the Security section is missing or the SSO test does not succeed.
  </Card>
</CardGroup>
