-
Notifications
You must be signed in to change notification settings - Fork 7
/
EndSessionRequest.yml
34 lines (27 loc) · 1.13 KB
/
EndSessionRequest.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
### YamlMime:TSTypeAlias
name: EndSessionRequest
uid: '@azure/msal-browser.EndSessionRequest'
package: '@azure/msal-browser'
summary: >-
EndSessionRequest
- account - Account object that will be logged out of. All
tokens tied to this account will be cleared.
- postLogoutRedirectUri - URI to navigate to after logout page.
- authority - Authority to send logout request to.
- correlationId - Unique GUID set per request to trace a request
end-to-end for telemetry purposes.
- idTokenHint - ID Token used by B2C to validate logout if required
by the policy
- onRedirectNavigate - Callback that will be passed the url that MSAL will
navigate to. Returning false in the callback will stop navigation.
- logoutHint - A string that specifies the account that is being
logged out in order to skip the server account picker on logout
fullName: EndSessionRequest
remarks: ''
isPreview: false
isDeprecated: false
syntax: |
type EndSessionRequest = Partial<CommonEndSessionRequest> & {
authority?: string,
onRedirectNavigate?: (url: string) => boolean | void,
}