MSAL-knooppunt configureren

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 Object PublicClientApplication of als onderdeel van de aanvraag-API's. Hier beschrijven we het configuratieobject dat kan worden doorgegeven aan de PublicClientApplication-constructor .

Prerequisites

Gebruik

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

Hieronder ziet u het configuratieobject met alle ondersteunde parameters:


// Call back APIs which automatically write and read into a .json file - example implementation
const beforeCacheAccess = async (cacheContext) => {
    cacheContext.tokenCache.deserialize(await fs.readFile(cachePath, "utf-8"));
};

const afterCacheAccess = async (cacheContext) => {
    if(cacheContext.cacheHasChanged){
        await fs.writeFile(cachePath, cacheContext.tokenCache.serialize());
    }
};

// Cache Plugin
const cachePlugin = {
    beforeCacheAccess,
    afterCacheAccess
};;

const msalConfig = {
    auth: {
        clientId: "enter_client_id_here",
        authority: "https://login.microsoftonline.com/common",
        knownAuthorities: [],
        cloudDiscoveryMetadata: "",
        azureCloudOptions: {
            azureCloudInstance: "enter_AzureCloudInstance_here" // AzureCloudInstance enum is exported as a "type",
            tenant: "enter_tenant_info" // defaults to "common"
        }
    },
    cache: {
        cachePlugin // your implementation of cache plugin
    },
    system: {
        loggerOptions: {
            loggerCallback(loglevel, message, containsPii) {
                console.log(message);
            },
            piiLoggingEnabled: false,
            logLevel: msal.LogLevel.Verbose,
        },
    }
}

const msalInstance = new PublicClientApplication(msalConfig);

Options

Configuratieopties voor verificatie

Option Description Format Standaardwaarde
clientId App-id van uw toepassing. U vindt deze in uw app-registratie in de Microsoft Entra-beheercentrum 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. Zie Prestaties voor meer informatie string Lege tekenreeks ""
authorityMetadata Een tekenreeks met het .known/openid-configuration endpoint response. Zie Prestaties voor meer informatie string Lege tekenreeks ""
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 die standaard worden ingesteld op hun specifieke cloudinstanties, voor specifieke clouds die worden ondersteund, raadpleegt u de AzureCloudInstance AzureCloudOptions AzureCloudInstance.None

Opties voor cacheconfiguratie

Option Description Format Standaardwaarde
cachePlugin Cache-invoegtoepassing met terugbellen naar lezen en schrijven in de cachepersistentie (zie ook: caching) ICachePlugin nul

Opties voor brokerconfiguratie

Option Description Format Standaardwaarde
nativeBrokerPlugin Broker-invoegtoepassing voor het verkrijgen van tokens via een systeemeigen tokenbroker (zie ook: brokering) INativeBrokerPlugin nul

Opties voor systeemconfiguratie

Option Description Format Standaardwaarde
loggerOptions Configuratieobject voor logboekregistratie. Zie hieronder. Zie hieronder.
NetworkClient Aangepaste HTTP-implementatie INetworkModule HttpClient.ts
protocolMode Opsomming van de protocolmodus die moet worden gebruikt. Als "AAD", werkt op de Microsoft Entra v2-eindpunten; als "OIDC", werkt op OIDC-compatibele eindpunten. string "AAD"
disableInternalRetries Indien waar, zal MSAL mislukte netwerkaanvragen niet opnieuw proberen boolean false

Note

In MSAL Node v5 zijn de proxyUrl en customAgentOptions parameters verwijderd. Als voor uw toepassing proxyondersteuning is vereist, implementeert u een aangepaste HTTP-client met behulp van INetworkModule. Zie het voorbeeld van de aangepaste INetworkModule voor een voorbeeld. De protocolMode parameter is ook verplaatst van verificatieconfiguratie naar systeemconfiguratie.

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

Opties voor telemetrieconfiguratie

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

Toepassingstelemetrie

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

Volgende stappen

Ga verder met het begrijpen van de openbare API's die worden msal-node geleverd voor het verkrijgen van tokens hier

  • Last updated on