Type alias EndSessionPopupRequest

EndSessionPopupRequest: Partial<Omit<CommonEndSessionRequest, "tokenQueryParameters">> & {
    authority?: string;
    mainWindowRedirectUri?: string;
    popupWindowAttributes?: PopupWindowAttributes;
    popupWindowParent?: Window;
}

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
  • popupWindowParent - Optional window object to use as the parent when opening popup windows. Uses global window if not given.

Type declaration

  • Optional authority?: string
  • Optional mainWindowRedirectUri?: string
  • Optional popupWindowAttributes?: PopupWindowAttributes
  • Optional popupWindowParent?: Window

Settings

Member Visibility

Theme

Generated using TypeDoc