From 8419a4cf4cadf4f5d74d7f0442d2d0247216f376 Mon Sep 17 00:00:00 2001 From: Steve Hobbs Date: Tue, 2 Jun 2020 13:56:59 +0100 Subject: [PATCH] Update docs for returnTo and client_id params on logout --- src/global.ts | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/global.ts b/src/global.ts index f836a9f1a..8cb359ea8 100644 --- a/src/global.ts +++ b/src/global.ts @@ -269,17 +269,25 @@ export interface LogoutOptions { /** * The URL where Auth0 will redirect your browser to after the logout. * - * > Note that if the `client_id` parameter is included, the + * **Note**: If the `client_id` parameter is included, the * `returnTo` URL that is provided must be listed in the * Application's "Allowed Logout URLs" in the Auth0 dashboard. * However, if the `client_id` parameter is not included, the * `returnTo` URL must be listed in the "Allowed Logout URLs" at * the account level in the Auth0 dashboard. + * + * [Read more about how redirecting after logout works](https://auth0.com/docs/logout/guides/redirect-users-after-logout) */ returnTo?: string; /** * The `client_id` of your application. + * + * If this property is not set, then the `client_id` that was used during initialization of the SDK is sent to the logout endpoint. + * + * If this property is set to `null`, then no client ID value is sent to the logout endpoint. + * + * [Read more about how redirecting after logout works](https://auth0.com/docs/logout/guides/redirect-users-after-logout) */ client_id?: string;