Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.69 KB

single-sign-on.rst

File metadata and controls

56 lines (40 loc) · 2.69 KB
Raw

Single Sign-On (SSO)

Single sign-on is an optional feature on for all users. By default, you will use teams </guides/manage-read-the-docs-teams> within Read the Docs to manage user authorization. SSO (single sign-on) will allow you to grant permissions to your organization's projects in an easy way.

Currently, we support two different types of single sign-on:

  • Authentication and authorization are managed by the identity provider (GitHub, Bitbucket or GitLab)
  • Authentication (only) is managed by the identity provider (Google Workspace account with a verified email address)

Users can log out by using the Log Out <versions:Logging out> link in the RTD flyout menu.

Single Sign-on with GitHub, Bitbucket, or GitLab

Using an identity provider that supports authentication and authorization allows organization owners to manage who has access to projects on Read the Docs, directly from the provider itself. If a user needs access to your documentation project on Read the Docs, that user just needs to be granted permissions in the Git repository associated with the project.

Once you enable this option, your existing Read the Docs teams will not be used. All authentication will be done using your git provider, including any two-factor authentication and additional Single Sign-on that they support.

Learn how to configure this SSO method with our /guides/setup-single-sign-on-github-gitlab-bitbucket.

SSO with Google Workspace

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 information about which projects a user has access to, permissions are managed by the internal Read the Docs's teams <commercial/organizations:Team Types> authorization system.

This feature is only available on the Pro plan and above. Learn how to configure this SSO method with our /guides/setup-single-sign-on-google-email.

Requesting additional providers

We are always interested in hearing from our users about what authentication needs they have. You can reach out to our /support to talk with us about any additional authentication needs you might have.

Tip

Many additional providers can be supported via GitHub, Bitbucket, and GitLab SSO. We will depend on those sites in order to authenticate you, so you can use all your existing SSO methods already configured on those services.