Type alias CommonEndSessionRequest

CommonEndSessionRequest: {
    account?: AccountInfo | null;
    correlationId: string;
    extraQueryParameters?: StringDict;
    idTokenHint?: string;
    logoutHint?: string;
    postLogoutRedirectUri?: string | null;
    state?: string;
}

CommonEndSessionRequest

  • 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.
  • 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
  • state - A value included in the request to the logout endpoint which will be returned in the query string upon post logout redirection
  • logoutHint - A string that specifies the account that is being logged out in order to skip the server account picker on logout
  • extraQueryParameters - String to string map of custom query parameters added to the /authorize call

Type declaration

  • Optional account?: AccountInfo | null
  • correlationId: string
  • Optional extraQueryParameters?: StringDict
  • Optional idTokenHint?: string
  • Optional logoutHint?: string
  • Optional postLogoutRedirectUri?: string | null
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc