Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
Mielőtt elkezdené, győződjön meg arról, hogy tisztában van az alkalmazásobjektumok inicializálásának módjával.
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 az objektum konstruktorában PublicClientApplication vagy a kérelem API-k részeként állíthatók be. Itt ismertetjük a konstruktornak PublicClientApplication átadható konfigurációs objektumot.
A konfigurációs objektum használata
A konfigurációs objektum a következő struktúrával rendelkezik, és átadható a PublicClientApplication konstruktornak. Az egyetlen szükséges konfigurációs paraméter az alkalmazás ügyfélazonosítója. Minden más nem kötelező, de a bérlőtől és az alkalmazásmodelltől függően szükség lehet rá.
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);
Konfigurációs 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. A Azure Portal alkalmazásregisztrációs panelen található | 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. | karakterlánc | Üres sztring "" |
authorityMetadata |
A .well-known/openid-configuration végpontválaszt tartalmazó sztring. | karakterlánc | Üres sztring "" |
redirectUri |
URI, amelyre az engedélyezési kód válaszát visszaküldi a rendszer. Az itt megadott helynek rendelkeznie kell az MSAL-kódtárzal a válasz kezeléséhez. | Sztring abszolút vagy relatív URI formátumban | Bejelentkezési kérelem lapja (window.location.href azon oldalról, amely hitelesítési kérelmet küldött) |
postLogoutRedirectUri |
URI, amely egy kijelentkezés() hívás után lesz átirányítva. | Abszolút vagy relatív URI formátumú sztring. Továbbítás null a kijelentkezés utáni átirányítás letiltásához. |
Bejelentkezési kérelem lapja (window.location.href azon oldalról, amely hitelesítési kérelmet küldött) |
navigateToLoginRequestUrl |
Ha true, az engedélyezési kód válaszának feldolgozása előtt vissza fog navigálni az eredeti kérelem helyére. Ha ugyanaz redirectUri , mint az eredeti kérelem helye, akkor ezt a jelölőt hamis értékre kell állítani. |
Logikai | true |
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 |
Az Azure Cloud-beállítások meghatározott készlete a fejlesztők számára, amelyek alapértelmezés szerint a saját felhőhatóságaikra vonatkoznak. | AzureCloudOptions | AzureCloudInstance.None |
skipAuthorityMetadataCache |
Jelölő, amely meghatározza, hogy a helyi metaadat-gyorsítótárat használja-e a szolgáltató inicializálása során. A metaadat-gyorsítótárat akkor használja a rendszer, ha nem ad meg szolgáltatói metaadatokat, és a metaadatok hálózati hívása előtt. | Logikai | false |
onRedirectNavigate |
Az MSAL URL-címnek átadott visszahívás átirányítási folyamatokba lép. A false visszahívásban való visszatérés leállítja a navigációt. |
Függvény – (url: string) => boolean \| void |
undefined |
instanceAware |
Egy jelző, amely jelzi, hogy az STS-nek további paramétereket kell-e küldenie, hogy megadják, honnan kell lekérni a jogkivonatokat. | Logikai | false |
isMcp |
Ha trueaz resource összes jogkivonat-kéréshez paraméterre van szükség. A Model Context Protocol (MCP) folyamatokhoz használatos. |
Logikai | false |
Gyorsítótár konfigurációs beállításai
| Option | Description | Format | Alapértelmezett érték |
|---|---|---|---|
cacheLocation |
A tokengyorsítótár helye a böngészőben. | Sztringérték, amely a következők egyikének kell lennie: "sessionStorage", , "localStorage""memoryStorage" |
sessionStorage |
temporaryCacheLocation |
(Elavult) Az ideiglenes gyorsítótár helye a böngészőben. Ezt a beállítást csak bizonyos peremes eseteknél kell módosítani. További információ: gyorsítótárazás. | Sztringérték, amely a következők egyikének kell lennie: "sessionStorage", , "localStorage""memoryStorage" |
sessionStorage |
storeAuthStateInCookie |
(Elavult) Ha igaz, a gyorsítótár elemeit a cookie-kban és a böngésző gyorsítótárában tárolja. Korábban Internet Explorer kompatibilitáshoz használták. | Logikai | false |
secureCookies |
(Elavult) Ha igaz, és storeAuthStateInCookie az is engedélyezve van, az MSAL hozzáadja a Secure jelölőt a böngésző cookie-hoz, hogy csak HTTPS-en keresztül lehessen elküldeni. |
Logikai | false |
cacheMigrationEnabled |
Ha igaz, a rendszer frissíti az MSAL régebbi verzióiból származó gyorsítótár-bejegyzéseket, hogy megfeleljenek a legújabb gyorsítótár-sémának az indításkor. Ha az alkalmazást nemrég nem frissítették a MSAL.jsúj verziójára, ezt nyugodtan kikapcsolhatja. Ha a régi gyorsítótárbejegyzések nem migrálva vannak, előfordulhat, hogy a gyorsítótár nem jelenik meg a fiókok vagy jogkivonatok lekérésekor, és előfordulhat, hogy az érintett felhasználóknak újra meg kell adniuk a hitelesítést, hogy naprakészek legyenek. | Logikai |
true használata localStorageesetén, false ellenkező esetben |
claimsBasedCachingEnabled |
Ha truea hozzáférési jogkivonatokat a rendszer a kért jogcímsztring kivonatát tartalmazó kulcs alatt gyorsítótárazza, ami azt eredményezi, hogy a gyorsítótár hiányzik, és új hálózati jogkivonat-kérés jön létre, amikor ugyanazt a jogkivonat-kérést különböző vagy hiányzó jogcímekkel kérik. Ha be van állítva, a falsejogkivonatok jogcímek nélkül gyorsítótárazódnak, de a jogcímeket tartalmazó összes kérés a hálózatra kerül, és felülírja a korábban gyorsítótárazott jogkivonatokat ugyanazokkal a hatókörökkel. |
Logikai | false |
Note
A temporaryCacheLocation beállítás elavult az MSAL Browser legújabb verzióiban, és egy későbbi nagyobb kiadásban el is távolítható. Az új implementációk esetében ne támaszkodjon erre a beállításra.
Note
Az storeAuthStateInCookie MSAL Browser legújabb verzióiban elavultak a beállítások és secureCookies a beállítások. Ezeket a beállításokat elsősorban Internet Explorer kompatibilitáshoz használták, ami már nem támogatott. Egy későbbi nagyobb kiadásban eltávolíthatók.
További információ : Gyorsítótárazás az MSAL-ben .
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. |
windowHashTimeout |
Időtúllépés ezredmásodpercben, hogy megvárja az előugró műveletek feloldását. | egész szám (ezredmásodperc) | 60000 |
iframeHashTimeout |
Időtúllépés ezredmásodpercben, hogy megvárja az iframe-műveletek feloldását. | egész szám (ezredmásodperc) | 6000 |
loadFrameTimeout |
Időtúllépés ezredmásodpercben az iframe/popup műveletek feloldására való várakozáshoz. Ha meg van adva, a program beállítja az alapértelmezett értékeket a következőhöz windowHashTimeout : és iframeHashTimeout. |
egész szám (ezredmásodperc) | undefined |
navigateFrameWait |
Késleltetés ezredmásodpercben, amíg az iframe betöltődik az ablakban. | egész szám (ezredmásodperc) | IE vagy Edge esetén: 500minden más böngészőben: 0 |
asyncPopups |
(Elavult – használja navigatePopups helyette.) Beállítja, hogy az előugró ablakok aszinkron módon nyílnak-e meg. Ha be van falseállítva, a rendszer üres előugró ablakokat nyit meg, mielőtt bármi más történne. Ha be van trueállítva, a rendszer megnyitja az előugró ablakokat a hálózati kérés végrehajtásakor. |
Logikai | false |
navigatePopups |
Beállítja, hogy az előugró ablakok megnyíljanak-e, és későbbre navigáljanak-e. Ha be van trueállítva, a rendszer üres előugró ablakokat nyit meg, majd navigál a bejelentkezési tartományhoz. Ha be van falseállítva, az előugró ablakok közvetlenül a bejelentkezési tartományba nyílnak meg. Ez olyan forgatókönyvekre állítható be false , amelyek about:blank nem támogatottak, például asztali vagy progresszív webalkalmazásokhoz. |
Logikai | true |
allowRedirectInIframe |
Alapértelmezés szerint az MSAL nem engedélyezi az átirányítási műveletek indítását, ha az alkalmazás egy iframe-ben van. Állítsa be ezt a jelzőt true az ellenőrzés eltávolításához. |
Logikai | false |
cryptoOptions |
Konfigurációs objektum titkosítási műveletekhez a böngészőben. | Lásd : Crypto Config Options | Lásd : Crypto Config Options |
pollIntervalMilliseconds |
Az előugró URL-kivonat lekérdezései közötti időintervallum ezredmásodpercben a hitelesítés során. | egész szám (ezredmásodperc) | 30 |
protocolMode |
A használni kívánt protokollmódot képviselő szám. Ha "AAD"az MSAL függvények az OIDC-kompatibilis AAD v2-végpontokon; ha "OIDC", akkor más OIDC-kompatibilis végpontokon működnek. |
karakterlánc | "AAD" |
Naplózó konfigurációs beállításai
| Option | Description | Format | Alapértelmezett érték |
|---|---|---|---|
loggerCallback |
Az MSAL-utasítások naplózását kezelő visszahívási függvény. | 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 |
Kriptográfiai konfigurációs beállítások
| Option | Description | Format | Alapértelmezett érték |
|---|---|---|---|
useMsrCrypto |
Az MSR Crypto használata, ha elérhető a böngészőben (és más titkosítási felületek nem érhetők el). | Logikai | false |
entropy |
Kriptográfiailag erős véletlenszerű értékek az MSR Crypto (pl. Node) magolásához. crypto.randomBytes(48) 48 bites entrópia ajánlott.
useMsrCrypto Ha engedélyezve van, kötelező megadni. |
Uint8Array |
undefined |
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 |
client |
Telemetriateljesítmény-ügyfélpéldány | IPerformanceClient | StubPerformanceClient |
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 |