|
| 1 | +<!-- markdownlint-disable MD024 MD012 --> |
1 | 2 | # Logout
|
2 | 3 | ## Auth0 Logout
|
3 | 4 |
|
@@ -121,13 +122,13 @@ Use this endpoint to logout a user. If you want to navigate the user to a specif
|
121 | 122 |
|
122 | 123 | | Parameter | Description |
|
123 | 124 | | :------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
124 |
| -| `id_token_hint` (Recommended) | Previously issued ID Token for the user. This is used to indicate which user to log out. | |
125 |
| -| `logout_hint` (Optional) | Optional `sid` (session ID) value to indicate which user to log out. Should be provided when `id_token_hint` is not available. | |
126 |
| -| `post_logout_redirect_uri` (Optional) | URL to redirect the user after the logout. | |
127 |
| -| `client_id` (Optional) | The `client_id` of your application. | |
128 |
| -| `federated` (Optional) | Add this query string parameter to log the user out of their identity provider: `https://YOUR_DOMAIN/oidc/logout?federated`. | |
129 |
| -| `state` (Optional) | An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the`post_logout_redirect_uri`. | |
130 |
| -| `ui_locales` (Optional) | Space-delimited list of locales used to constrain the language list for the request. The first locale on the list must match the enabled locale in your tenant | |
| 125 | +| `id_token_hint` <br/><span class="label label-primary">Recommended</span> | Previously issued ID Token for the user. This is used to indicate which user to log out. | |
| 126 | +| `logout_hint` <br/><span class="label label-primary">Optional</span> | Optional `sid` (session ID) value to indicate which user to log out. Should be provided when `id_token_hint` is not available. | |
| 127 | +| `post_logout_redirect_uri` <br/><span class="label label-primary">Optional</span> | URL to redirect the user after the logout. | |
| 128 | +| `client_id` <br/><span class="label label-primary">Optional</span> | The `client_id` of your application. | |
| 129 | +| `federated` <br/><span class="label label-primary">Optional</span> | Add this query string parameter to log the user out of their identity provider: `https://YOUR_DOMAIN/oidc/logout?federated`. | |
| 130 | +| `state` <br/><span class="label label-primary">Optional</span> | An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the`post_logout_redirect_uri`. | |
| 131 | +| `ui_locales` <br/><span class="label label-primary">Optional</span> | Space-delimited list of locales used to constrain the language list for the request. The first locale on the list must match the enabled locale in your tenant | |
131 | 132 |
|
132 | 133 | ### Remarks
|
133 | 134 |
|
|
0 commit comments