Edit

Share via


InteractiveRequest type

Request object passed by user to configure acquireTokenInteractive API

  • openBrowser - Function to open a browser instance on user's system.
  • scopes - Array of scopes the application is requesting access to.
  • successTemplate: - Template to be displayed on the opened browser instance upon successful token acquisition.
  • errorTemplate - Template to be displayed on the opened browser instance upon token acquisition failure.
  • windowHandle - Used in native broker flows to properly parent the native broker window
  • loopbackClient - Custom implementation for a loopback server to listen for authorization code response.
type InteractiveRequest = Partial<
  Omit<
    CommonAuthorizationUrlRequest,
    "scopes" | "redirectUri" | "requestedClaimsHash" | "storeInCache"
  >
> & {
  errorTemplate?: string
  loopbackClient?: ILoopbackClient
  openBrowser: (url: string) => Promise<void>
  scopes?: string[]
  successTemplate?: string
  windowHandle?: Buffer
}