Type alias BrowserAuthOptions

BrowserAuthOptions: {
    OIDCOptions?: OIDCOptions;
    authority?: string;
    authorityMetadata?: string;
    azureCloudOptions?: AzureCloudOptions;
    clientCapabilities?: string[];
    clientId: string;
    cloudDiscoveryMetadata?: string;
    encodeExtraQueryParams?: boolean;
    instanceAware?: boolean;
    knownAuthorities?: string[];
    navigateToLoginRequestUrl?: boolean;
    onRedirectNavigate?: ((url) => boolean | void);
    postLogoutRedirectUri?: string | null;
    protocolMode?: ProtocolMode;
    redirectUri?: string;
    skipAuthorityMetadataCache?: boolean;
    supportsNestedAppAuth?: boolean;
}

Use this to configure the auth options in the Configuration object

Type declaration

  • Optional OIDCOptions?: OIDCOptions

    Enum that configures options for the OIDC protocol mode.

  • Optional authority?: string

    You can configure a specific authority, defaults to " " or "https://login.microsoftonline.com/common"

  • Optional authorityMetadata?: string

    A string containing the .well-known/openid-configuration endpoint response

  • Optional azureCloudOptions?: AzureCloudOptions

    Enum that represents the Azure Cloud to use.

  • Optional clientCapabilities?: string[]

    Array of capabilities which will be added to the claims.access_token.xms_cc request property on every network request.

  • clientId: string

    Client ID of your app registered with our Application registration portal : https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview in Microsoft Identity Platform

  • Optional cloudDiscoveryMetadata?: string

    A string containing the cloud discovery response. Used in AAD scenarios.

  • Optional encodeExtraQueryParams?: boolean

    Flag of whether to encode query parameters

    Deprecated

    This flag is deprecated and will be removed in the next major version where all extra query params will be encoded by default.

  • Optional instanceAware?: boolean

    Flag of whether the STS will send back additional parameters to specify where the tokens should be retrieved from.

  • Optional knownAuthorities?: string[]

    An array of URIs that are known to be valid. Used in B2C scenarios.

  • Optional navigateToLoginRequestUrl?: boolean

    Boolean indicating whether to navigate to the original request URL after the auth server navigates to the redirect URL.

  • Optional onRedirectNavigate?: ((url) => boolean | void)
      • (url): boolean | void

      • Callback that will be passed the url that MSAL will navigate to in redirect flows. Returning false in the callback will stop navigation.

        Parameters

        • url: string

        Returns boolean | void

  • Optional postLogoutRedirectUri?: string | null

    The redirect URI where the window navigates after a successful logout.

  • Optional protocolMode?: ProtocolMode

    Enum that represents the protocol that msal follows. Used for configuring proper endpoints.

  • Optional redirectUri?: string

    The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.

  • Optional skipAuthorityMetadataCache?: boolean

    Flag of whether to use the local metadata cache

  • Optional supportsNestedAppAuth?: boolean

    App supports nested app auth or not; defaults to

    Deprecated

    This flag is deprecated and will be removed in the next major version. createNestablePublicClientApplication should be used instead.

Settings

Member Visibility

Theme

Generated using TypeDoc