Products:RedocRevelReefRealm
Plans:ProEnterpriseEnterprise+
Configure a URL where users are redirected after they log out. After a user logs out of your project and their session cookies are cleared, they will be redirected to the URL specified in logoutReturnUrl. If not specified, users are redirected to the root path of your project by default.
This is useful when you want users to return to your main website or a specific page after logging out, rather than staying on the documentation site.
The logoutReturnUrl property is only available as a child of the access object.
| Option | Type | Description |
|---|---|---|
| logoutReturnUrl | string | URL that users are redirected to after logging out. Must start with http:// or https://. |
The recommended way to configure logoutReturnUrl is within the access object:
redocly.yaml
access:
logoutReturnUrl: https://yourcompany.comThe following example redirects users to a custom logout page:
redocly.yaml
access:
logoutReturnUrl: https://yourcompany.com/logout-successCommon use cases for logoutReturnUrl:
- Corporate portals: Redirect users back to your main corporate website after logout
- Public sites: Redirect to your public-facing website after logout
- Landing pages: Send users to a specific landing page or homepage after logout
- Access configuration - Group authentication and access settings together using the
accessobject - RequiresLogin configuration - Require login for your project
- SSO configuration - Configure single sign-on for your project