Skip to content

Commit 34c9edf

Browse files
authored
Merge pull request #8063 from readthedocs/humitos/enable-sso-docs
SSO: add small paragraph mentioning how to enable it on commercial
2 parents 34da5b1 + e04c5a4 commit 34c9edf

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

docs/commercial/single-sign-on.rst

+15-12
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,7 @@ Single Sign-On is supported on |com_brand| for Pro and Enterprise plans.
1212
Currently, we support two different types of Single Sign-On:
1313

1414
* Authentication *and* authorization are managed by the Identity Provider (e.g. GitHub, Bitbucket or GitLab)
15-
* Authentication (*only*) is managed by the Identity Provider (e.g. an active GSuite/Google ``@company.com`` with a verified email address)
16-
17-
.. note::
18-
19-
SSO is currently in **Beta** and only GitHub, Bitbucket, GitLab and Google are supported for now.
20-
If you would like to apply for the Beta, please `contact us <mailto:[email protected]>`_.
15+
* Authentication (*only*) is managed by the Identity Provider (e.g. an active Google Workspace account with a verified email address)
2116

2217
.. contents::
2318
:local:
@@ -32,6 +27,10 @@ Using an Identity Provider that supports authentication and authorization allows
3227
In case you want a user to have access to your documentation project under Read the Docs,
3328
that user just needs to be granted permissions in the VCS repository associated with it.
3429

30+
You can enable this feature in your organization by going to
31+
your organization's detail page > :guilabel:`Settings` > :guilabel:`Authorization`
32+
and selecting :guilabel:`GitHub, GitLab or Bitbucket` as provider.
33+
3534
Note the users created under Read the Docs must have their GitHub, Bitbucket or GitLab
3635
:doc:`account connected </connected-accounts>` in order to make SSO to work.
3736

@@ -78,8 +77,8 @@ but still want that user to have access to read the documentation.
7877
Instead of revoking access completely, just need lower down permissions to **read** only.
7978

8079

81-
SSO with GSuite (Google email account)
82-
--------------------------------------
80+
SSO with Google Workspace
81+
-------------------------
8382

8483
Using your company's Google email address (e.g. ``[email protected]``) allows you to
8584
manage authentication for your organization's members.
@@ -90,12 +89,16 @@ By default, users that Sign Up with a Google account do not have any permissions
9089
However, you can define which Teams users matching your company's domain email address will auto-join when they Sign Up.
9190
Read the following sections to learn how to grant read and admin access.
9291

92+
You can enable this feature in your organization by going to
93+
your organization's detail page > :guilabel:`Settings` > :guilabel:`Authorization`
94+
and selecting :guilabel:`Google` as provider and specifying your Google Workspace domain in the :guilabel:`Domain` field.
95+
9396

9497
Grant access to read a project
9598
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9699

97100
You can add a user under a "Read Only Team" to grant **read** permissions to all the projects under that Team.
98-
This can be done under "your organization detail's page" > :guilabel:`Teams` > :guilabel:`Read Only` > :guilabel:`Invite Member`.
101+
This can be done under your organization's detail page > :guilabel:`Teams` > :guilabel:`Read Only` > :guilabel:`Invite Member`.
99102

100103
To avoid this repetitive task for each employee of your company,
101104
the owner of the Read the Docs organization can mark one or many Teams for users matching the company's domain email
@@ -111,7 +114,7 @@ Grant access to administer a project
111114
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112115

113116
You can add a user under an "Admin Team" to grant **admin** permissions to all the projects under that Team.
114-
This can be done under "your organization detail's page" > :guilabel:`Teams` > :guilabel:`Admins` > :guilabel:`Invite Member`.
117+
This can be done under your organization's detail page > :guilabel:`Teams` > :guilabel:`Admins` > :guilabel:`Invite Member`.
115118

116119

117120
Grant access to users to import a project
@@ -128,11 +131,11 @@ Revoke user's access to a project
128131
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129132

130133
To revoke access to a project for a particular user, you should remove that user from the Team that contains that Project.
131-
This can be done under "your organization detail's page" > :guilabel:`Teams` > :guilabel:`Read Only` and click :guilabel:`Remove` next to the user you want to revoke access.
134+
This can be done under your organization's detail page > :guilabel:`Teams` > :guilabel:`Read Only` and click :guilabel:`Remove` next to the user you want to revoke access.
132135

133136

134137
Revoke user's access to all the projects
135138
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136139

137-
By disabling the GSuite/Google account with email ``[email protected]``,
140+
By disabling the Google Workspace account with email ``[email protected]``,
138141
you revoke access to all the projects that user had access and disable login on Read the Docs completely for that user.

0 commit comments

Comments
 (0)