Type alias InteractiveRequest

InteractiveRequest: Pick<AuthorizationUrlRequest, "authority" | "correlationId" | "claims" | "azureCloudOptions" | "account" | "extraQueryParameters" | "tokenQueryParameters" | "extraScopesToConsent" | "loginHint" | "prompt"> & {
    errorTemplate?: string;
    loopbackClient?: ILoopbackClient;
    openBrowser: ((url) => Promise<void>);
    scopes?: string[];
    successTemplate?: string;
    windowHandle?: Buffer;
}

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 declaration

  • Optional errorTemplate?: string
  • Optional loopbackClient?: ILoopbackClient
  • openBrowser: ((url) => Promise<void>)
      • (url): Promise<void>

      • Parameters

        • url: string

        Returns Promise<void>

  • Optional scopes?: string[]
  • Optional successTemplate?: string
  • Optional windowHandle?: Buffer

Settings

Member Visibility

Theme

Generated using TypeDoc