Skip to content
Last updated

sso

Products:RedocRedocRevelRevelReefReefRealmRealm
Plans:EnterpriseEnterprise+

Restrict project login to specific identity provider categories defined in Reunite. This configuration determines which IdPs are available for logging in to a project. Configuring SSO by itself does not require users to log in to access a project. To require login to a project, rbac or requiresLogin must also be configured.

Options

OptionTypeDescription

sso

[string]

List of identity provider categories from Reunite. Possible values: REDOCLY, CORPORATE, GUEST, or []. A category corresponds to the Login type assigned to an identity provider in Reunite.

To target a specific identity provider by its unique ID, use access.idps instead of sso. access.sso and access.idps are mutually exclusive and cannot be configured together.

Default value: AUTO - used when neither sso nor idps is defined. It offers GUEST IdPs, if any are defined in Reunite. Otherwise, it offers CORPORATE IdPs, if defined in Reunite. When a category contains a single IdP, users are redirected to this IdP. With multiple IdPs, users choose one on the login screen. If no IdPs are defined it falls back to the REDOCLY IdP, giving users the option to log in using their Redocly credentials or Social Login providers (like Google).

Examples

The recommended way to configure sso is within the access object:

redocly.yaml
access:
  sso:
    - GUEST
    - REDOCLY

Disable SSO

The following example disables SSO using the access object:

redocly.yaml
access:
  sso: []

After applying this configuration, if you have rbac configured for the same project, and there are pages assigned to the authenticated default team, those pages are not accessible to anyone. Otherwise, if you do not have rbac configured, or you have all pages assigned to the anonymous default team, all pages are accessible.

Root-level configuration (deprecated)

Deprecated configuration

Root-level sso configuration displays warnings when the access object is present. Migrate to the access object format.

redocly.yaml
sso:
  - GUEST
  - REDOCLY

Resources

  • Access configuration - Group authentication and access settings together using the access object
  • RBAC configuration - Complete options for configuring role-based access control for granular project permissions and user management
  • RequiresLogin configuration - Require login for all users to your project without implementing complex role-based access control
  • Google Workspace SAML 2 SSO - Integrate Google Workspace SAML 2 SSO with Reunite for enterprise authentication workflows
  • Single Sign-on concepts - Understand different identity provider categories in Reunite and how they apply to project authentication
  • Add an identity provider - Follow steps to add identity providers in Reunite for centralized authentication management
  • Configure SSO - Enable multiple identity provider categories to give users flexible authentication options for your projects
  • Role-based access control (RBAC) - Implement advanced access control scenarios to grant specific users access to specific content and features

aiAssistant