Skip to content

Commit

Permalink
Update docs for returnTo and client_id params on logout
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Hobbs committed Jun 2, 2020
1 parent 6f9fd3b commit 8419a4c
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/global.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down

0 comments on commit 8419a4c

Please sign in to comment.