Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Než začnete tady, ujistěte se, že rozumíte tomu, jak inicializovat objekt aplikace.
Knihovna MSAL obsahuje sadu možností konfigurace, které lze použít k přizpůsobení chování toků ověřování. Tyto možnosti lze nastavit buď v konstruktoru objektu PublicClientApplication , nebo jako součást rozhraní API požadavku. Zde popisujeme objekt konfigurace, který lze předat do konstruktoru PublicClientApplication .
Použití konfiguračního objektu
Objekt konfigurace má následující strukturu a lze jej předat do konstruktoru PublicClientApplication . Jediným povinným parametrem konfigurace je ID klienta aplikace. Všechno ostatní je volitelné, ale může se vyžadovat v závislosti na vašem tenantovi a modelu aplikace.
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);
Možnosti konfigurace
Možnosti konfigurace ověřování
| Option | Description | Formát | Výchozí hodnota |
|---|---|---|---|
clientId |
ID aplikace Najdete ji v podokně registrace Azure Portal aplikace. | UUID/GUID | Žádná Tento parametr je povinný, aby služba MSAL mohla provádět jakékoli akce. |
authority |
Identifikátor URI tenanta pro ověření a autorizaci. Obvykle má formu https://{uri}/{tenantid} |
Řetězec ve formátu URI s tenantem – https://{uri}/{tenantid} |
https://login.microsoftonline.com/common |
knownAuthorities |
Pole identifikátorů URI, o kterých je známo, že jsou platné. Používá se ve scénářích B2C. | Pole řetězců ve formátu identifikátoru URI | Prázdné pole [] |
cloudDiscoveryMetadata |
Řetězec obsahující odpověď cloud discovery. Používá se v Microsoft Entra scénářích. | řetězec | Prázdný řetězec "" |
authorityMetadata |
Řetězec obsahující odpověď koncového bodu .well-known/openid-configuration. | řetězec | Prázdný řetězec "" |
redirectUri |
Identifikátor URI, do kterého se odešle odpověď autorizačního kódu. Pro zpracování odpovědi musí být k dispozici knihovna MSAL bez ohledu na to, kde je zde zadané umístění. | Řetězec v absolutním nebo relativním formátu identifikátoru URI | Stránka žádosti o přihlášení (window.location.href ze stránky, která provedla žádost o ověření) |
postLogoutRedirectUri |
Identifikátor URI, který se přesměruje na volání logout() | Řetězec v absolutním nebo relativním formátu identifikátoru URI Předáním null zakážete přesměrování po odhlášení. |
Stránka žádosti o přihlášení (window.location.href ze stránky, která provedla žádost o ověření) |
navigateToLoginRequestUrl |
Pokud truese před zpracováním odpovědi autorizačního kódu vrátí zpět do původního umístění požadavku.
redirectUri Pokud je stejný jako původní umístění požadavku, měl by být tento příznak nastaven na false. |
Boolean | true |
clientCapabilities |
Pole možností, které se mají přidat do všech síťových požadavků jako součást xms_cc žádosti o deklarace identity |
Pole řetězců | [] |
azureCloudOptions |
Definovaná sada možností cloudu Azure pro vývojáře, kteří mají výchozí nastavení pro své konkrétní cloudové autority. | AzureCloudOptions | AzureCloudInstance.None |
skipAuthorityMetadataCache |
Příznak, který se má rozhodnout, jestli se má při inicializaci autority použít místní mezipaměť metadat. Mezipaměť metadat se používá, pokud nejsou zadána žádná metadata autority a před vytvořením síťového volání metadat. | Boolean | false |
onRedirectNavigate |
Zpětné volání, které předá adresu URL MSAL, přejde do toků přesměrování.
false Vrácení zpět v zpětném volání zastaví navigaci. |
Funkce – (url: string) => boolean \| void |
undefined |
instanceAware |
Příznak určující, jestli má služba STS odesílat další parametry, které určují, odkud se mají tokeny načíst. | Boolean | false |
isMcp |
Pokud trueje resource parametr povinný pro všechny požadavky na tokeny. Používá se pro toky PROTOKOLU MCP (Model Context Protocol). |
Boolean | false |
Možnosti konfigurace mezipaměti
| Option | Description | Formát | Výchozí hodnota |
|---|---|---|---|
cacheLocation |
Umístění mezipaměti tokenů v prohlížeči | Řetězcová hodnota, která musí být jedna z následujících hodnot: "sessionStorage", "localStorage""memoryStorage" |
sessionStorage |
temporaryCacheLocation |
(Zastaralé) Umístění dočasné mezipaměti v prohlížeči Tato možnost by se měla změnit jenom u konkrétních hraničních případů. Další informace najdete v tématu ukládání do mezipaměti. | Řetězcová hodnota, která musí být jedna z následujících hodnot: "sessionStorage", "localStorage""memoryStorage" |
sessionStorage |
storeAuthStateInCookie |
(Zastaralé) Pokud je pravda, ukládá položky mezipaměti do souborů cookie i do mezipaměti prohlížeče. Dříve se používala pro kompatibilitu Internet Explorer. | Boolean | false |
secureCookies |
(Zastaralé) Pokud je hodnota true a storeAuthStateInCookie je povolena, msAL přidá Secure příznak do souboru cookie prohlížeče, aby se mohl odesílat pouze přes PROTOKOL HTTPS. |
Boolean | false |
cacheMigrationEnabled |
Pokud je pravda, položky mezipaměti ze starších verzí knihovny MSAL se aktualizují tak, aby odpovídaly nejnovějšímu schématu mezipaměti při spuštění. Pokud se vaše aplikace nedávno neaktualizovala na novou verzi MSAL.js, můžete ji bezpečně vypnout. Pokud se nemigrují staré položky mezipaměti, může při pokusu o načtení účtů nebo tokenů dojít k chybě mezipaměti a ovlivnění uživatelé možná budou muset znovu provést ověření, aby se dostali k aktuálnímu stavu. | Boolean |
true při použití localStorage, false jinak |
claimsBasedCachingEnabled |
Pokud truese přístupové tokeny ukládají do mezipaměti pod klíčem obsahujícím hodnotu hash požadovaného řetězce deklarací identity, výsledkem je neúspěšná mezipaměť a nová žádost o token sítě, když se stejný požadavek na token provede s různými nebo chybějícími deklaracemi identity. Pokud je nastavená hodnota false, tokeny se ukládají do mezipaměti bez deklarací identity, ale všechny požadavky obsahující deklarace identity přejdou do sítě a přepíší všechny dříve uložené tokeny v mezipaměti se stejnými obory. |
Boolean | false |
Note
Tato temporaryCacheLocation možnost je v posledních verzích prohlížeče MSAL zastaralá a může být odebrána v budoucí hlavní verzi. U nových implementací byste se neměli spoléhat na tuto možnost.
Note
V storeAuthStateInCookie posledních verzích prohlížeče MSAL byly zastaralé možnosti secureCookies a možnosti. Tyto možnosti se primárně používaly pro Internet Explorer kompatibilitu, která se už nepodporuje. Mohou být odebrány v budoucí hlavní verzi.
Další informace najdete v tématu Ukládání do mezipaměti v MSAL .
Možnosti konfigurace systému
| Option | Description | Formát | Výchozí hodnota |
|---|---|---|---|
loggerOptions |
Objekt konfigurace pro protokolovací nástroj. | Viz níže. | Viz níže. |
windowHashTimeout |
Vypršení časového limitu v milisekundách, aby se vyřešily místní operace. | celé číslo (milisekundy) | 60000 |
iframeHashTimeout |
Vypršení časového limitu v milisekundách, aby se operace iframe vyřešily. | celé číslo (milisekundy) | 6000 |
loadFrameTimeout |
Vypršení časového limitu v milisekundách a čekání na vyřešení operací iframe/popup Pokud je k dispozici, nastaví výchozí hodnoty pro windowHashTimeout a iframeHashTimeout. |
celé číslo (milisekundy) | undefined |
navigateFrameWait |
Zpoždění v milisekundách, než se element iframe načte v okně. | celé číslo (milisekundy) | V IE nebo Edgi: 500ve všech ostatních prohlížečích: 0 |
asyncPopups |
(Zastaralé – použijte navigatePopups místo toho.) Nastaví, jestli se automaticky otevírané okno otevírá asynchronně. Pokud je nastavená hodnota false, otevřou se prázdné automaticky otevírané okno před tím, než se stane cokoli jiného. Při nastavení se truepři vytváření síťového požadavku otevřou automaticky otevírané okno. |
Boolean | false |
navigatePopups |
Nastaví, jestli se automaticky otevírané okno otevře a přejde na později. Pokud je tato možnost nastavená na true, otevře se prázdné automaticky otevírané okno a pak přejděte do přihlašovací domény. Při nastavení se falseautomaticky otevírané okno otevře přímo do přihlašovací domény. To se dá nastavit false pro scénáře, ve kterých about:blank se nepodporuje, jako jsou desktopové aplikace nebo progresivní webové aplikace. |
Boolean | true |
allowRedirectInIframe |
Ve výchozím nastavení msAL neumožňuje inicializovány operace přesměrování, když je aplikace uvnitř prvku iframe. Nastavte tento příznak tak, aby true se tato kontrola odebrala. |
Boolean | false |
cryptoOptions |
Objekt konfigurace pro kryptografické operace v prohlížeči. | Viz Možnosti konfigurace kryptografie | Viz Možnosti konfigurace kryptografie |
pollIntervalMilliseconds |
Interval času v milisekundách mezi dotazy na hodnotu hash místní adresy URL během ověřování | celé číslo (milisekundy) | 30 |
protocolMode |
Výčet představující režim protokolu, který se má použít. Pokud "AAD", MSAL funkce na koncových bodech AAD v2 kompatibilních s OIDC; pokud "OIDC", funguje na jiných koncových bodech kompatibilních s OIDC. |
řetězec | "AAD" |
Možnosti konfigurace protokolovacího nástroje
| Option | Description | Formát | Výchozí hodnota |
|---|---|---|---|
loggerCallback |
Funkce zpětného volání, která zpracovává protokolování příkazů MSAL. | Funkce- loggerCallback: (level: LogLevel, message: string, containsPii: boolean): void |
Viz výše. |
piiLoggingEnabled |
Pokud je to pravda, v protokolech se zahrnou identifikovatelné osobní údaje .PII. | Boolean | false |
Možnosti konfigurace kryptografie
| Option | Description | Formát | Výchozí hodnota |
|---|---|---|---|
useMsrCrypto |
Zda použít MSR Crypto , pokud je k dispozici v prohlížeči (a jiné kryptografické rozhraní nejsou k dispozici). | Boolean | false |
entropy |
Kryptograficky silné náhodné hodnoty používané k počátečnímu msR Crypto (např. crypto.randomBytes(48) z uzlu). Doporučuje se 48 bitů entropie. Vyžaduje se, pokud useMsrCrypto je povoleno. |
Uint8Array |
undefined |
Možnosti konfigurace telemetrie
| Option | Description | Formát | Výchozí hodnota |
|---|---|---|---|
application |
Možnosti telemetrie pro aplikace používající MSAL.js | Viz níže | Viz níže |
client |
Instance klienta výkonu telemetrie | IPerformanceClient | StubPerformanceClient |
Telemetrie aplikací
| Option | Description | Formát | Výchozí hodnota |
|---|---|---|---|
appName |
Jedinečný název řetězce aplikace | řetězec | Prázdný řetězec "" |
appVersion |
Verze aplikace používající knihovnu MSAL | řetězec | Prázdný řetězec "" |