-
Notifications
You must be signed in to change notification settings - Fork 6
/
EndSessionPopupRequest.yml
39 lines (31 loc) · 1.33 KB
/
EndSessionPopupRequest.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
35
36
37
38
39
### YamlMime:TSTypeAlias
name: EndSessionPopupRequest
uid: '@azure/msal-browser.EndSessionPopupRequest'
package: '@azure/msal-browser'
summary: >-
EndSessionPopupRequest
- 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 inside the
popup. Required to ensure popup can be closed.
- 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
- mainWindowRedirectUri - URI to navigate the main window to after logout is
complete
- popupWindowAttributes - Optional popup window attributes. popupSize with
height and width, and popupPosition with top and left can be set.
- logoutHint - A string that specifies the account that is being
logged out in order to skip the server account picker on logout
fullName: EndSessionPopupRequest
remarks: ''
isPreview: false
isDeprecated: false
syntax: |
type EndSessionPopupRequest = Partial<CommonEndSessionRequest> & {
authority?: string,
mainWindowRedirectUri?: string,
popupWindowAttributes?: PopupWindowAttributes,
}