After you have added an identity provider (IdP) in Reunite, the IdP can then be configured in the redocly.yaml configuration file for individual projects. Adding an IdP 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 in the default priority order. You can configure sso in the redocly.yaml file of a project, to specify identity providers for that project. See the Single sign-on (SSO) concept doc for more information on the default priority order.
Configuring sso does not require users to log in to your project. To require login to a project, rbac or requiresLogin must also be configured.
Make sure you have the following before you begin:
- a
redocly.yamlconfiguration file with one of the following configured:rbacdefined for theauthenticateddefault teamrequiresLogin
- identity provider (IdP) information added in Reunite
If you want to specify which identity providers (IdPs) users can log in to your project with, you can configure sso in the redocly.yaml configuration file.
For example, the following sso configuration limits users to the CORPORATE IdP, if it has been added in Reunite:
sso:
- CORPORATEThe following example allows users to use both the GUEST IdP (if it has been added in Reunite) and REDOCLY credentials:
sso:
- GUEST
- REDOCLYRedocly credentials are credentials created and saved in Reunite.
If you have configured rbac, but want to disable SSO, use the following sso configuration:
sso: []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.
- Add an identity provider - Add identity providers in Reunite for unified authentication across projects and Reunite login
- Configure RBAC - Implement role-based access control to restrict user access to specific project content and features
- SSO configuration reference - Complete reference documentation for all available SSO configuration options and settings
- Single sign-on (SSO) concepts - Understand different identity provider types and implementation approaches for your project authentication needs
- Role-based access control (RBAC) concepts - Understand how RBAC works in projects and Reunite for comprehensive access management
- RBAC configuration reference - Complete reference for configuring RBAC options in your redocly.yaml file with examples and implementation details