MSAL-csomópont konfigurálása

Az MSAL-kódtár konfigurációs lehetőségek készletével testre szabhatja a hitelesítési folyamatok viselkedését. Ezek a beállítások a PublicClientApplication objektum konstruktorában vagy a kérelem API-k részeként állíthatók be. Itt ismertetjük a PublicClientApplication konstruktornak átadható konfigurációs objektumot.

Prerequisites

Használat

A konfigurációs objektum átadható a PublicClientApplication konstruktornak. Az egyetlen szükséges konfigurációs paraméter az client_id alkalmazás. Minden más nem kötelező, de szükség lehet a hitelesítési folyamattól, a bérlői és az alkalmazásmodelltől függően.

Az összes támogatott paramétert tartalmazó konfigurációs objektum az alábbiakban látható:


// 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);

Beállítások

Hitelesítés konfigurációs beállításai

Option Description Format Alapértelmezett érték
clientId Az alkalmazás alkalmazásazonosítója. Az alkalmazásregisztrációban megtalálható az Microsoft Entra felügyeleti központ alkalmazásregisztrációban. UUID/GUID Nincs. Ez a paraméter szükséges ahhoz, hogy az MSAL bármilyen műveletet végrehajthasson.
authority A bérlő URI-ja a hitelesítéshez és a hitelesítéshez. Általában a https://{uri}/{tenantid} URI formátumú sztring bérlővel – https://{uri}/{tenantid} https://login.microsoftonline.com/common
knownAuthorities Az ismerten érvényes URI-k tömbje. B2C-forgatókönyvekben használatos. Sztringek tömbje URI formátumban Üres tömb []
cloudDiscoveryMetadata A felhőfelderítési választ tartalmazó sztring. Microsoft Entra forgatókönyvekben használatos. További információkért tekintse meg a Teljesítmény című témakört karakterlánc Üres sztring ""
authorityMetadata A .well-known/openid-configuration végpontválaszt tartalmazó sztring. További információkért tekintse meg a Teljesítmény című témakört karakterlánc Üres sztring ""
clientCapabilities A jogcímkérelem részeként az összes hálózati kérelemhez hozzáadandó képességek tömbje xms_cc Sztringek tömbje []
azureCloudOptions A fejlesztők által az adott felhőhatóságok számára alapértelmezett azure-felhőbeállítások meghatározott készlete, a támogatott felhők esetében tekintse meg az AzureCloudInstance-t AzureCloudOptions AzureCloudInstance.None

Gyorsítótár konfigurációs beállításai

Option Description Format Alapértelmezett érték
cachePlugin Gyorsítótár beépülő modul visszahívásokkal a gyorsítótár-adatmegőrzésbe való olvasáshoz és íráshoz (lásd még: gyorsítótárazás) ICachePlugin null

Közvetítő konfigurációs beállításai

Option Description Format Alapértelmezett érték
nativeBrokerPlugin Közvetítő beépülő modul a jogkivonatok natív jogkivonat-közvetítőn keresztüli beszerzéséhez (lásd még: közvetítés) INativeBrokerPlugin null

Rendszerkonfiguráció beállításai

Option Description Format Alapértelmezett érték
loggerOptions Konfigurálja a naplózó objektumát. Lásd alább. Lásd alább.
NetworkClient Egyéni HTTP-implementáció INetworkModule HttpClient.ts
protocolMode A használni kívánt protokollmódot képviselő szám. Ha "AAD", akkor a Microsoft Entra v2-végpontokon fog működni, ha "OIDC"az OIDC-kompatibilis végpontokon fog működni. karakterlánc "AAD"
disableInternalRetries Ha igaz, az MSAL nem próbálkozik újra a sikertelen hálózati kérésekkel Logikai false

Note

Az MSAL Node 5-ös verzióban a rendszer eltávolította a paramétereket és customAgentOptions a proxyUrl paramétereket. Ha az alkalmazás proxytámogatást igényel, implementáljon egy egyéni HTTP-ügyfelet az INetworkModule használatával. Egy példaért tekintse meg az egyéni INetworkModule-mintát . A protocolMode paraméter a hitelesítési konfigurációról a rendszerkonfigurációra is át lett helyezve.

Naplózó konfigurációs beállításai

Option Description Format Alapértelmezett érték
loggerCallback Visszahívási függvény, amely az MSAL-utasítások naplózását kezeli. Funkció- loggerCallback: (level: LogLevel, message: string, containsPii: boolean): void Lásd fentebb.
piiLoggingEnabled Ha igaz, a naplók tartalmazzák a személyazonosításra alkalmas adatokat (PII). Logikai false

Telemetriai konfigurációs beállítások

Option Description Format Alapértelmezett érték
application Telemetriai beállítások MSAL.js használó alkalmazásokhoz Lásd alább Lásd alább

Alkalmazás telemetriai adatai

Option Description Format Alapértelmezett érték
appName Alkalmazás egyedi sztringneve karakterlánc Üres "" sztring
appVersion Az alkalmazás verziója az MSAL használatával karakterlánc Üres "" sztring

Következő lépések

A jogkivonatok beszerzéséhez biztosított msal-node nyilvános API-k megismerése

  • Last updated on