Opties voor verificatieconfiguratie

Voordat u hier begint, moet u weten hoe u een app-object initialiseert.

De MSAL-bibliotheek bevat een set configuratieopties die kunnen worden gebruikt om het gedrag van uw verificatiestromen aan te passen. Deze opties kunnen worden ingesteld in de constructor van het PublicClientApplication object of als onderdeel van de aanvraag-API's. Hier beschrijven we het configuratieobject dat kan worden doorgegeven aan de PublicClientApplication constructor.

Het configuratieobject gebruiken

Het configuratieobject heeft de volgende structuur en kan worden doorgegeven aan de PublicClientApplication constructor. De enige vereiste configuratieparameter is de client-id van de toepassing. Alles anders is optioneel, maar is mogelijk vereist, afhankelijk van uw tenant en toepassingsmodel.

const msalConfig = {
    auth: {
        clientId: "enter_client_id_here",
        authority: "https://login.microsoftonline.com/common",
        knownAuthorities: [],
        cloudDiscoveryMetadata: "",
        redirectUri: "enter_redirect_uri_here",
        postLogoutRedirectUri: "enter_postlogout_uri_here",
        navigateToLoginRequestUrl: true,
        clientCapabilities: ["CP1"],
    },
    cache: {
        cacheLocation: "sessionStorage",
    },
    system: {
        loggerOptions: {
            loggerCallback: (
                level: LogLevel,
                message: string,
                containsPii: boolean
            ): void => {
                if (containsPii) {
                    return;
                }
                switch (level) {
                    case LogLevel.Error:
                        console.error(message);
                        return;
                    case LogLevel.Info:
                        console.info(message);
                        return;
                    case LogLevel.Verbose:
                        console.debug(message);
                        return;
                    case LogLevel.Warning:
                        console.warn(message);
                        return;
                }
            },
            piiLoggingEnabled: false,
        },
        windowHashTimeout: 60000,
        iframeHashTimeout: 6000,
        loadFrameTimeout: 0,
        protocolMode: "AAD"
    },
    telemetry: {
        application: {
            appName: "My Application",
            appVersion: "1.0.0",
        },
    },
};

const msalInstance = new PublicClientApplication(msalConfig);

Configuratieopties

Configuratieopties voor verificatie

Option Description Format Standaardwaarde
clientId App-id van uw toepassing. U vindt deze in het deelvenster Azure Portal app-registratie UUID/GUID Geen. Deze parameter is vereist om MSAL acties uit te voeren.
authority URI van de tenant om te verifiëren en te autoriseren met. Meestal heeft de vorm van https://{uri}/{tenantid} Tekenreeks in URI-indeling met tenant - https://{uri}/{tenantid} https://login.microsoftonline.com/common
knownAuthorities Een matrix met URI's die bekend zijn als geldig. Wordt gebruikt in B2C-scenario's. Matrix van tekenreeksen in URI-indeling Lege matrix []
cloudDiscoveryMetadata Een tekenreeks met het antwoord op clouddetectie. Wordt gebruikt in Microsoft Entra scenario's. string Lege tekenreeks ""
authorityMetadata Een tekenreeks met het .known/openid-configuration endpoint response. string Lege tekenreeks ""
redirectUri URI waarnaar het antwoord van de autorisatiecode wordt teruggestuurd. Op welke locatie hier ook wordt opgegeven, moet de MSAL-bibliotheek beschikbaar zijn om het antwoord af te handelen. Tekenreeks in absolute of relatieve URI-indeling Aanmeldingsaanvraagpagina (window.location.href van pagina die een verificatieaanvraag heeft ingediend)
postLogoutRedirectUri URI die wordt omgeleid naar nadat een aanroep van afmelding() is uitgevoerd. Tekenreeks in absolute of relatieve URI-indeling. Geef door null omleiding na afmelding uit te schakelen. Aanmeldingsaanvraagpagina (window.location.href van pagina die een verificatieaanvraag heeft ingediend)
navigateToLoginRequestUrl Als true, gaat u terug naar de oorspronkelijke aanvraaglocatie voordat u het antwoord van de autorisatiecode verwerkt. Als de redirectUri locatie van de oorspronkelijke aanvraag hetzelfde is, moet deze vlag worden ingesteld op false. boolean true
clientCapabilities Matrix van mogelijkheden die moeten worden toegevoegd aan alle netwerkaanvragen als onderdeel van de xms_cc claimaanvraag Array van tekenreeksen []
azureCloudOptions Een gedefinieerde set azure-cloudopties voor ontwikkelaars om standaard hun specifieke cloudinstanties te gebruiken. AzureCloudOptions AzureCloudInstance.None
skipAuthorityMetadataCache Een vlag om te kiezen of de lokale metagegevenscache moet worden gebruikt tijdens de initialisatie van de instantie. De metagegevenscache wordt gebruikt als er geen instantiemetagegevens worden opgegeven en voordat er een netwerkoproep voor metagegevens is gemaakt. boolean false
onRedirectNavigate Een callback die is doorgegeven aan de URL MSAL, navigeert naar in omleidingsstromen. Als u false terugkomt in de callback, wordt de navigatie gestopt. Functie- (url: string) => boolean \| void undefined
instanceAware Een vlag die aangeeft of de STS aanvullende parameters moet terugsturen om op te geven waar tokens van moeten worden opgehaald. boolean false
isMcp Als trueer een resource parameter is vereist voor alle tokenaanvragen. Wordt gebruikt voor MCP-stromen (Model Context Protocol). boolean false

Opties voor cacheconfiguratie

Option Description Format Standaardwaarde
cacheLocation Locatie van tokencache in browser. Tekenreekswaarde die een van de volgende waarden moet zijn: "sessionStorage", "localStorage""memoryStorage" sessionStorage
temporaryCacheLocation (Afgeschaft) Locatie van tijdelijke cache in browser. Deze optie mag alleen worden gewijzigd voor specifieke edge-aanvragen. Zie caching voor meer informatie. Tekenreekswaarde die een van de volgende waarden moet zijn: "sessionStorage", "localStorage""memoryStorage" sessionStorage
storeAuthStateInCookie (Afgeschaft) Indien waar, slaat u cache-items op in cookies en in de browsercache. Werd eerder gebruikt voor Internet Explorer compatibiliteit. boolean false
secureCookies (Afgeschaft) Als waar en storeAuthStateInCookie ook is ingeschakeld, voegt MSAL de Secure vlag toe aan de browsercooky, zodat deze alleen via HTTPS kan worden verzonden. boolean false
cacheMigrationEnabled Indien waar, worden cachevermeldingen van oudere versies van MSAL bijgewerkt om te voldoen aan het meest recente cacheschema bij het opstarten. Als uw toepassing niet onlangs is bijgewerkt naar een nieuwe versie van MSAL.js, kunt u deze functie veilig uitschakelen. Als oude cachevermeldingen niet worden gemigreerd, kan dit resulteren in een cachemissing bij het ophalen van accounts of tokens en moeten betrokken gebruikers mogelijk opnieuw verifiëren om up-to-date te raken. boolean true bij gebruik localStorage, false anders
claimsBasedCachingEnabled Als truetoegangstokens worden opgeslagen in de cache onder een sleutel met de hash van de aangevraagde claimsreeks, wat resulteert in een cachemissing en een nieuwe netwerktokenaanvraag wanneer dezelfde tokenaanvraag wordt gedaan met verschillende of ontbrekende claims. Als deze optie is ingesteld false, worden tokens zonder claims in de cache opgeslagen, maar alle aanvragen met claims gaan naar het netwerk en overschrijven alle eerder in de cache opgeslagen token met dezelfde bereiken. boolean false

Note

De temporaryCacheLocation optie is afgeschaft in recente versies van MSAL Browser en kan worden verwijderd in een toekomstige primaire release. U moet niet afhankelijk zijn van deze optie voor nieuwe implementaties.

Note

De storeAuthStateInCookie opties en secureCookies opties zijn afgeschaft in recente versies van MSAL Browser. Deze opties werden voornamelijk gebruikt voor Internet Explorer compatibiliteit, die niet meer wordt ondersteund. Ze kunnen worden verwijderd in een toekomstige primaire release.

Zie Caching in MSAL voor meer informatie.

Opties voor systeemconfiguratie

Option Description Format Standaardwaarde
loggerOptions Configuratieobject voor logboekregistratie. Zie hieronder. Zie hieronder.
windowHashTimeout Time-out in milliseconden om te wachten tot pop-upbewerkingen zijn opgelost. geheel getal (milliseconden) 60000
iframeHashTimeout Time-out in milliseconden om te wachten tot iframebewerkingen zijn opgelost. geheel getal (milliseconden) 6000
loadFrameTimeout Time-out in milliseconden om te wachten tot iframe-/pop-upbewerkingen zijn opgelost. Indien opgegeven, worden standaardwaarden ingesteld voor windowHashTimeout en iframeHashTimeout. geheel getal (milliseconden) undefined
navigateFrameWait Vertraging in milliseconden om te wachten totdat het iframe in het venster wordt geladen. geheel getal (milliseconden) In IE of Edge: 500, in alle andere browsers: 0
asyncPopups (Afgeschaft - gebruik navigatePopups in plaats daarvan.) Hiermee stelt u in of pop-ups asynchroon worden geopend. Als dit is ingesteld false, worden lege pop-ups geopend voordat er iets anders gebeurt. Wanneer dit is ingesteld true, worden pop-ups geopend bij het indienen van de netwerkaanvraag. boolean false
navigatePopups Hiermee stelt u in of pop-ups worden geopend en naar later worden genavigeerd. Als dit is ingesteld true, worden lege pop-ups geopend en navigeert u vervolgens naar het aanmeldingsdomein. Wanneer dit is ingesteld false, worden pop-ups rechtstreeks geopend in het aanmeldingsdomein. Dit kan worden ingesteld op false scenario's waarbij about:blank dit niet wordt ondersteund, zoals desktop-apps of progressieve web-apps. boolean true
allowRedirectInIframe MsAL staat standaard niet toe dat omleidingsbewerkingen worden gestart wanneer de toepassing zich in een iframe bevindt. Stel deze vlag in om true deze controle te verwijderen. boolean false
cryptoOptions Configuratieobject voor cryptobewerkingen in de browser. Zie Crypto-configuratieopties Zie Crypto-configuratieopties
pollIntervalMilliseconds Interval van tijd in milliseconden tussen polls van pop-up-URL-hash tijdens verificatie. geheel getal (milliseconden) 30
protocolMode Opsomming van de protocolmodus die moet worden gebruikt. Als "AAD", MSAL functies op de OIDC-compatibele AAD v2-eindpunten; als , werkt "OIDC"het op andere OIDC-compatibele eindpunten. string "AAD"

Configuratieopties voor logboekregistratie

Option Description Format Standaardwaarde
loggerCallback De callback-functie die de logboekregistratie van MSAL-instructies afhandelt. Functie- loggerCallback: (level: LogLevel, message: string, containsPii: boolean): void Zie hierboven.
piiLoggingEnabled Indien waar, worden persoonlijke gegevens (PII) opgenomen in logboeken. boolean false

Crypto-configuratieopties

Option Description Format Standaardwaarde
useMsrCrypto Of u MSR Crypto wilt gebruiken als deze beschikbaar is in de browser (en andere crypto-interfaces zijn niet beschikbaar). boolean false
entropy Cryptografische sterke willekeurige waarden die worden gebruikt om MSR Crypto te seeden (bijvoorbeeld crypto.randomBytes(48) van Node). 48 bits entropie wordt aanbevolen. Vereist indien useMsrCrypto ingeschakeld. Uint8Array undefined

Opties voor telemetrieconfiguratie

Option Description Format Standaardwaarde
application Telemetrieopties voor toepassingen die gebruikmaken van MSAL.js Zie hieronder Zie hieronder
client Telemetrieprestatieclientexemplaren IPerformanceClient StubPerformanceClient

Toepassingstelemetrie

Option Description Format Standaardwaarde
appName Unieke tekenreeksnaam van een toepassing string Lege tekenreeks ""
appVersion Versie van de toepassing met MSAL string Lege tekenreeks ""