Last updated

Single sign-on (SSO)

Single sign-on (SSO) is an authentication method that allows users to log in with a single identity to several related, but independent, software systems. You can add SSO identity providers (IdPs) to Reunite to allow users to use them for logging into Reunite as well as individual projects. After you add an IdP to Reunite, the IdP can then be configured in the redocly.yaml configuration file for individual projects.

Identity provider types in Reunite

You can add an instance of one or both of the two types of identity providers in Reunite:

  • Corporate: used to authenticate internal users into Reunite and projects.
  • Guest: used to authenticate external users into projects.

For each Reunite type, you can connect to your identity provider using either the SAML 2 or OpenID Connect protocol. You can also enable SCIM 2.0 and require that users use SSO to authenticate into your organization.

Identity provider types in redocly.yaml

When configuring the redocly.yaml configuration file for individual projects, you can add one or all of the three possible identity provider types:

  • REDOCLY: This value represents credentials managed by Redocly and allows users to log in with their Redocly password or social login providers, like Google.
  • CORPORATE: This value represents credentials for the IdP you added as a Corporate identity provider in Reunite.
  • GUEST: This value represents credentials for the IdP you added as a Guest identity provider in Reunite.

The values listed are the identity providers (IdPs), if added in Reunite, users can use to log in to the project. To use or combine specific identity providers, configure sso in the redocly.yaml file of the project.

Default priority order

Adding an identity provider to the configuration file for a project is not required for users to be able to use it to log in. If you do NOT configure sso in the redocly.yaml file for a project, users can log in to the project using IdPs you have added in Reunite with the following default priority order:

  • GUEST: If you have added a GUEST IdP in Reunite, users must log in to projects using it.
  • CORPORATE: If you have added a CORPORATE IdP in Reunite and have not entered a GUEST IdP, users must log in to projects using the CORPORATE IdP.
  • REDOCLY: If you have not added either a GUEST or CORPORATE IdP in Reunite, users must log in to projects using their Redocly credentials or social login providers, like Google.

Verified domains

Verified domains are a way for you to connect users with a given organization. They only apply to corporate identity providers when logging into Reunite, not logging in to projects. You can add a Verified domain on the SSO and login page in Reunite.

When you add a Verified domain to your organization, users logging in to Reunite with the verified domain email are automatically directed to the corporate identity provider, with the option to use Redocly credentials or social logins. If you also select to require SSO authentication, users logging in to Reunite with the verified domain email domain can only log in using the corporate identity provider.

Team mapping

Team mapping is an option when you add a Corporate or Guest IdP. The option name differs depending on the protocol you are using to connect:

  • For OpenID Connect, the option is referred to as team claim mapping.
  • For SAML 2, the option is referred to as team attribute mapping.

In both instances, team mapping is a way to map your internal IdP group names to either Redocly default teams based on organization roles or project RBAC teams configured in your redocly.yaml file.

Disable SSO

You can disable SSO for individual projects. When you disable SSO for a project, there is no log in page for that project. Disabling SSO is only necessary if you have rbac configured, but you don't want to require login to your project. Disabling SSO removes the login page, but does not disable rbac.

Resources

 
Next page