Skip to content
Last updated

requiresLogin

Products:RedocRedocRevelRevelReefReefRealmRealm
Plans:ProEnterpriseEnterprise+

This configuration option makes all your content private for non-authenticated users. Only authenticated users, who are verified through either Redocly or an identity provider (IdP) you added in Reunite can access your project.

The requiresLogin option cannot be used in conjunction with the rbac. These configurations are mutually exclusive.

Examples

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

redocly.yaml
access:
  requiresLogin: true

Root-level configuration (deprecated)

Deprecated: Root-level requiresLogin is still supported for backward compatibility but will show deprecation warnings when used alongside the access object. Please migrate to the access object format.

redocly.yaml
requiresLogin: true

Resources

  • Access configuration - Group authentication and access settings together using the access object
  • RBAC configuration - Complete options for configuring role-based access control as an alternative to requiresLogin for granular permissions
  • SSO configuration - Discover options for configuring single sign-on to work with requiresLogin for streamlined user authentication
 
Next page