Skip to content

Commit

Permalink
Docs: Update Google SSO docs (#11191)
Browse files Browse the repository at this point in the history
* Docs: Update Google SSO docs

To better reflect the current state of Google SSO.

* Use new session expiration
  • Loading branch information
stsewd committed Mar 7, 2024
1 parent e7631a3 commit bba466b
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/user/commercial/single-sign-on.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Learn how to configure this SSO method with our :doc:`/guides/setup-single-sign-
SSO with Google Workspace
-------------------------

This feature allows you to restrict access to users with a specific email address (e.g. ``employee@company.com``),
This feature allows you to easily manage access to users with a specific email address (e.g. ``employee@company.com``),
where ``company.com`` is a registered Google Workspace domain.
As this identity provider does not provide authorization over each project a user has access to,
As this identity provider does not provide information about which projects a user has access to,
permissions are managed by the :ref:`internal Read the Docs's teams <commercial/organizations:Team Types>` authorization system.

This feature is only available on the **Pro plan** and above.
Expand Down
29 changes: 27 additions & 2 deletions docs/user/guides/setup-single-sign-on-google-email.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ User setup
~~~~~~~~~~

Using this setup,
all users who have access to the configured Google Workspace will be granted a subset of permissions on your organization automatically on account creation.
all users who have access to the configured Google Workspace will automatically join to your organization when they sign up with their Google account.
Existing users will not be automatically joined to the organization.

You can still add outside collaborators and manage their access.
There are two ways to manage this access:
Expand All @@ -42,6 +43,14 @@ However, you can define which teams users matching your company's domain email a
2. Select **Google** in the :guilabel:`Provider` drop-down.
3. Press :guilabel:`Save`.

After enabling SSO with Google Workspace,
all users with email addresses from your configured Google Workspace domain will be required to signup using their Google account.

.. warning::

Existing users with email addresses from your configured Google Workspace domain will not be required to link their Google account,
but they won't be automatically joined to your organization.

Configure team for all users to join
------------------------------------

Expand All @@ -62,7 +71,23 @@ Revoke user's access to all the projects
----------------------------------------

By disabling the Google Workspace account with email ``employee@company.com``,
you revoke access to all the projects that user had access and disable login on Read the Docs completely for that user.
you revoke access to all the projects the linked Read the Docs user had access to,
and disable login on Read the Docs completely for that user.

.. warning::

If the user signed up to Read the Docs previously to enabling SSO with Google Workspace on your organization,
they may still have access to their account and projects if they were manually added to a team.

To completely revoke access to a user, remove them from all the teams they are part of.

.. warning::

If the user was already signed in to Read the Docs when their access was revoked,
they may still have access to documentation pages until their session expires.
This is three days for the dashboard and documentation pages.

To completely revoke access to a user, remove them from all the teams they are part of.

.. seealso::

Expand Down

0 comments on commit bba466b

Please sign in to comment.