@azure/msal-common package

Allgemeine Fehlerklasse, die von der MSAL.js Bibliothek ausgelöst wird.

Dies ist eine Hilfsklasse, die unterstützte HTTP-Antwortauthentifizierungsheader analysiert, um Abfragewerte für Header zu extrahieren und zurückzugeben, die außerhalb der grundlegenden Autorisierungsflüsse verwendet werden können.

Fehler beim Auftreten eines Fehlers mit dem Cache

Fehler ausgelöst, wenn im Clientcode, der im Browser ausgeführt wird, ein Fehler auftritt.

Fehler ausgelöst, wenn bei der Konfiguration der MSAL.js-Bibliothek ein Fehler auftritt.

Fehler, der ausgelöst wird, wenn eine Benutzerinteraktion erforderlich ist.

Klasse, die die Protokollierung von Nachrichten an einem bestimmten Ort erleichtert.

Stellt Netzwerkbezogene Fehler dar.

Fehlerklasse für MSAL-Runtime-Fehler, die detaillierte Brokerinformationen erhalten

Klasse, die Hilfsprogramme für OAuth 2.0-Protokollspezifische Werte bereitstellt

Die ScopeSet-Klasse erstellt einen Satz von Bereichen. Bereiche sind ohne Groß-/Kleinschreibung, eindeutige Werte, sodass das Set-Objekt in JS am sinnvollsten für diese Klasse implementiert werden kann. Alle Bereiche werden gekürzt und in Kleinbuchstaben in Schnittmengen- und Vereinigungsfunktionen konvertiert, um die Eindeutigkeit von Zeichenfolgen sicherzustellen.

Fehler, der ausgelöst wird, wenn ein Fehler mit dem Servercode auftritt, z. B. nicht verfügbar.

Url-Objektklasse, die verschiedene Transformationen für URL-Zeichenfolgen ausführen kann.

Diese Klasseninstanz hilft, die Speicheränderungen nachzuverfolgen, wodurch Entscheidungen zum Lesen und Schreiben in den persistenten Cache erleichtert werden.

Schnittstelle für kryptografische Funktionen, die von der Bibliothek verwendet werden

Clientnetzwerkschnittstelle zum Senden von Back-End-Anforderungen.

Schnittstelle, die URI-Komponenten beschreibt.

Zugriffstokencachetyp

Konto: <home_account_id-Umgebungsbereich<>><*>

Account-Objekt mit der folgenden Signatur:

• homeAccountId – Startkontobezeichner für dieses Kontoobjekt
• Environment – Entität, die das token ausgestellt hat, das durch die Domäne des Ausstellers dargestellt wird (z. B. login.microsoftonline.com)
• tenantId – Vollständige Mandanten- oder Organisations-ID, zu der dieses Konto gehört
• benutzername - preferred_username Anspruch der id_token, die dieses Konto darstellt
• localAccountId – Lokale, mandantenspezifische Kontoidentifer für dieses Kontoobjekt, in der Regel in Legacyfällen verwendet
• Name – Vollständiger Name für das Konto, einschließlich Vorname und Familienname
• idToken – Unformatiertes ID-Token
• idTokenClaims – Objekt enthält Ansprüche aus dem ID-Token
• nativeAccountId – Die systemeigene Konto-ID des Benutzers
• tenantProfiles – Zuordnung von Mandantenprofilobjekten für jeden Mandanten, mit dem das Konto im Browser authentifiziert wurde
• dataBoundary – Aus clientInfo extrahierte Datengrenze

Cachetyp für App-Metadaten

Telemetrieinformationen, die auf Anfrage gesendet werden

• appName: Eindeutiger Zeichenfolgenname einer Anwendung
• appVersion: Version der Anwendung mit MSAL

Ergebnis, das vom Tokenendpunkt der Autorität zurückgegeben wird.

• uniqueId – oid oder sub Anspruch von ID-Token
• tenantId – tid Anspruch aus ID-Token
• Bereiche – Bereiche, die für das jeweilige Token überprüft werden
• account – Eine Kontoobjektdarstellung des aktuell angemeldeten Benutzers
• idToken – Id-Token, das als Teil der Antwort empfangen wurde
• idTokenClaims – MSAL-relevante ID-Tokenansprüche
• accessToken – Zugriffstoken oder SSH-Zertifikat, das als Teil der Antwort empfangen wurde
• fromCache – Boolescher Wert, der angibt, ob das Token aus dem Cache stammt
• expiresOn – Javascript Date-Objekt, das den relativen Ablauf des Zugriffstokens darstellt
• extExpiresOn – Javascript Date-Objekt, das den erweiterten relativen Ablauf des Zugriffstokens im Falle eines Serverausfalls darstellt
• refreshOn – Javascript Date-Objekt, das relative Zeit darstellt, bis ein Zugriffstoken aktualisiert werden muss
• state - Wert, der vom Benutzer in Anforderung übergeben wird
• familyId – Familien-ID-Id, in der Regel nur für Aktualisierungstoken verwendet
• requestId – Anforderungs-ID, die als Teil der Antwort zurückgegeben wird

Antwort, die nach der Verarbeitung der Codeantwortabfragezeichenfolge oder des Fragments zurückgegeben wurde.

Antworteigenschaften, die vom /authorize-Endpunkt zurückgegeben werden können

Spezifische AzureCloudInstance-Optionen

• azureCloudInstance – Zeichenfolgenaufzählung, die kurze Notation für soverign und öffentliche Cloud-Behörden bereitstellt
• mandant – Bereitstellen der Mandanteninformationen

BaseAuthRequest

• authority – URL der Autorität, des Sicherheitstokendiensts (SECURITY Token Service, STS), aus dem MSAL Token abruft. Wird standardmäßig auf https://login.microsoftonline.com/common festgelegt. Wenn Sie dieselbe Autorität für alle Anforderungen verwenden, sollte die Autorität für das Clientanwendungsobjekt und nicht für die Anforderung festgelegt werden, um das Auflösen von Autoritätsendpunkten mehrmals zu vermeiden.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• authenticationScheme – Der Typ des abgerufenen Tokens. Der Standardwert ist "Bearer". Kann auch "pop" oder "SSH" eingeben.
• Ansprüche – Eine Zeichenfolgenansprücheanforderung, die allen /authorize- und /token-Aufrufen hinzugefügt wird
• shrClaims – Ein objekt mit Zeichenfolgenansprüchen, das einer signierten HTTP-Anforderung hinzugefügt wird
• shrNonce – Ein vom Server generierter Zeitstempel, der verschlüsselt und base64URL codiert wurde, der einer signierten HTTP-Anforderung hinzugefügt wird.
• shrOptions – Ein Objekt mit Optionen für die signierte HTTP-Anforderung
• resourceRequestMethod – HTTP-Anforderungstyp, der zum Anfordern von Daten aus der Ressource verwendet wird (z. B. "GET", "POST", usw.). Wird für Besitznachweisflüsse verwendet.
• resourceRequestUri – URI, für den das Token verwendet wird. Wird für Besitznachweisflüsse verwendet.
• sshJwk – Ein stringified JSON Web Key, der einen öffentlichen Schlüssel darstellt, der von einem SSH-Zertifikat signiert werden kann.
• sshKid – Schlüssel-ID, die den oben erwähnten öffentlichen SSH-Schlüssel eindeutig identifiziert.
• azureCloudOptions – Convenience-Zeichenfolgen-Enumerationen für Benutzer, um öffentliche/souveräne Cloud-IDs bereitzustellen
• requestedClaimsHash – SHA 256-Hashzeichenfolge der angeforderten Anspruchszeichenfolge, die als Teil eines Zugriffstokencacheschlüssels verwendet wird, damit Token nach angeforderten Ansprüchen gefiltert werden können
• tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden
• tokenBodyParameters – Zeichenfolge zu Zeichenfolgenzuordnung von benutzerdefinierten Parametern, die dem Textkörper des /token-Aufrufs hinzugefügt wurden
• storeInCache – Objekt, das boolesche Werte enthält, die angeben, ob Token im Cache gespeichert werden sollen oder nicht (Standard ist true)
• scenarioId – Szenario-ID zum Nachverfolgen von benutzerdefinierten Benutzeraufforderungen
• popKid – Schlüssel-ID zum Identifizieren des öffentlichen Schlüssels für poP-Tokenanforderung
• embeddedClientId – Eingebettete Client-ID. Wenn angegeben, werden Broker-Client-ID (brk_client_id) und Umleitungs-URI -Params (brk_redirect_uri) mit Werten aus der Konfiguration festgelegt, wobei die entsprechenden zusätzlichen Parameter außer Kraft gesetzt werden, sofern vorhanden.
• httpMethod - HTTP-Methode, die für die /authorize-Anforderung verwendet werden soll. Standardmäßig ist GET festgelegt, kann aber auf POST festgelegt werden, wenn für die Anforderung Textparameter erforderlich sind.
• authorizePostBodyParameters – String to string map of custom parameters added to the body of the /authorize call when httpMethod is set to POST
• skipBrokerClaims – Wenn "true" und ein vermittelter Fluss verwendet wird (z. B. wenn Broker-Params oder eingebetteteClientId vorhanden sind), werden ClientCapabilities aus der Konfiguration von Ansprüchen ausgeschlossen; wird für nichtbrokerte Flüsse ignoriert.

Verwenden Sie diese Einstellung zum Konfigurieren der Cacheeinstellungen für Anmeldeinformationen im ClientConfiguration-Objekt.

• claimsBasedCachingEnabled – Legt fest, ob Token basierend auf dem Anspruchshash zwischengespeichert werden sollen. Die Standardeinstellung ist "false".

Client info object which consists of: uid: user id utid: tenant id xms_tdbr: optional, only for non-US tenants

Anforderungsobjekt, das vom Benutzer übergeben wird, um ein Token vom Server abzurufen, der einen gültigen Autorisierungscode austauscht (zweiter Teil des OAuth2.0-Autorisierungscodeflusses)

• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• Ansprüche – Eine Zeichenfolgenansprücheanforderung, die allen /authorize- und /token-Aufrufen hinzugefügt wird
• authority: - URL der Autorität, der Sicherheitstokendienst (SECURITY Token Service, STS), aus dem MSAL Token erwirbt. Wenn die Autorität für das Clientanwendungsobjekt festgelegt ist, überschreibt dies diesen Wert. Das Überschreiben des Werts bewirkt, dass die Autoritätsüberprüfung jedes Mal erfolgt. Wenn die gleiche Autorität für alle Anforderungen verwendet wird, legen Sie das Anwendungsobjekt anstelle der Anforderungen fest.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• redirectUri – Der Umleitungs-URI Ihrer App, an den die Autorität nach eingaben Anmeldeinformationen und Zustimmungen des Benutzers umgeleitet wird. Es muss genau mit einer der Umleitungs-URIs übereinstimmen, die Sie im Portal registriert haben.
• code – Die authorization_code, die der Benutzer im ersten Abschnitt des Flusses erworben hat.
• codeVerifier – Dieselbe code_verifier, die zum Abrufen der authorization_code verwendet wurde. Erforderlich, wenn PKCE in der Autorisierungscodeerteilungsanforderung verwendet wurde. Weitere Informationen finden Sie im PKCE RFC: https://tools.ietf.org/html/rfc7636
• resourceRequestMethod – HTTP-Anforderungstyp, der zum Anfordern von Daten aus der Ressource verwendet wird (z. B. "GET", "POST", usw.). Wird für Besitznachweisflüsse verwendet.
• resourceRequestUri – URI, für den das Token verwendet wird. Wird für Besitznachweisflüsse verwendet.
• enableSpaAuthCode – Aktiviert die Acqusition eines Spa-Autorisierungscodes (nur vertrauliche Clients)
• tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden

Anforderungsobjekt, das vom Benutzer übergeben wird, um einen Code vom Server abzurufen (First Leg of Authorization Code Grant Flow)

• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• Ansprüche – Eine Zeichenfolgenansprücheanforderung, die allen /authorize- und /token-Aufrufen hinzugefügt wird
• authority – URL der Autorität, von der die Anwendung Token erwirbt.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• redirectUri – Der Umleitungs-URI, in dem Authentifizierungsantworten von Ihrer Anwendung empfangen werden können. Es muss genau mit einer der Umleitungs-URIs übereinstimmen, die im Azure-Portal registriert sind.
• extraScopesToConsent – Bereiche für eine andere Ressource, wenn der Benutzer die Zustimmung vorab benötigt.
• responseMode – Gibt die Methode an, die verwendet werden soll, um das Authentifizierungsergebnis an Ihre App zu senden. Kann Abfragen, form_post oder Fragmente sein. Wenn kein Wert übergeben wird, wird standardmäßig eine Abfrage verwendet.
• codeChallenge - Wird verwendet, um die Autorisierungscodeerteilung über Proof of Key for Code Exchange (PKCE) zu sichern. Weitere Informationen finden Sie im PKCE RCF:https://tools.ietf.org/html/rfc7636
• codeChallengeMethod – Die Methode, die zum Codieren der Codeüberprüfung für den Codeabfrageparameter verwendet wird. Kann "nur" oder "S256" sein. Wenn ausgeschlossen, wird angenommen, dass die Codeabfrage Nur-Text ist. Weitere Informationen finden Sie im PKCE RCF: https://tools.ietf.org/html/rfc7636
• state – Ein in der Anforderung enthaltener Wert, der auch in der Tokenantwort zurückgegeben wird. Ein zufällig generierter eindeutiger Wert wird in der Regel verwendet, um Websiteanforderungs-Fälschungsangriffe zu verhindern. Der Zustand wird auch verwendet, um Informationen zum Status des Benutzers in der App zu codieren, bevor die Authentifizierungsanforderung aufgetreten ist.
• prompt - Gibt den Typ der Benutzerinteraktion an, die erforderlich ist. Anmeldung: Erzwingt, dass der Benutzer seine Anmeldeinformationen für diese Anforderung eingibt, wobei einmaliges Anmelden nicht deaktiviert wird: Stellt sicher, dass dem Benutzer keine interaktive Eingabeaufforderung angezeigt wird. Wenn die Anforderung nicht über einmaliges Anmelden abgeschlossen werden kann, gibt der Endpunkt eine interaction_required Fehlerzustimmung zurück: Löst das OAuth-Zustimmungsdialogfeld aus, nachdem sich der Benutzer angemeldet hat, und fordert den Benutzer auf, berechtigungen für die App select_account zu erteilen: wird einmaliges Sign-=beim Bereitstellen der Kontoauswahl-Erfahrung unterbrochen, in der alle Konten in sitzungsinternen oder gespeicherten Konten aufgelistet werden, oder eine Option, um eine andere Kontoerstellung zu verwenden: leitet den Benutzer an die Kontoerstellungsoberfläche anstelle der Anmeldeoberfläche no_session: liest beim Authentifizieren des Benutzers kein vorhandenes Sitzungstoken vor. Wenn der Benutzer erfolgreich authentifiziert wurde, erstellt EVO keine neue Sitzung für den Benutzer. NUR ZUR INTERNEN VERWENDUNG.
• account – AccountInfo, das von einer getAccount-API abgerufen wurde. Wird in bestimmten Szenarien verwendet, um login_hint zu generieren, wenn sowohl loginHint- als auch sid-Params nicht bereitgestellt werden.
• loginHint – Kann verwendet werden, um das Feld "Benutzername/E-Mail-Adresse" der Anmeldeseite für den Benutzer vorab auszufüllen, wenn Sie den Benutzernamen/die E-Mail-Adresse vorab kennen. Häufig verwenden Apps diesen Parameter während der erneuten Authentifizierung, nachdem Sie den Benutzernamen bereits aus einer vorherigen Anmeldung mithilfe des preferred_username Anspruchs extrahiert haben.
• sid – Sitzungs-ID, eindeutiger Bezeichner für die Sitzung. Verfügbar als optionaler Anspruch für ID-Token.
• domainHint : Stellt einen Hinweis auf den Mandanten oder die Domäne bereit, den der Benutzer für die Anmeldung verwenden soll. Der Wert des Domänenhinweiss ist eine registrierte Domäne für den Mandanten.
• extraQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /authorize-Aufruf hinzugefügt wurden
• tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden
• nonce – Ein Wert, der in der Anforderung enthalten ist, die im ID-Token zurückgegeben wird. Ein zufällig generierter eindeutiger Wert wird in der Regel verwendet, um Replay-Angriffe zu minimieren.
• resourceRequestMethod – HTTP-Anforderungstyp, der zum Anfordern von Daten aus der Ressource verwendet wird (z. B. "GET", "POST", usw.). Wird für Besitznachweisflüsse verwendet.
• resourceRequestUri – URI, für den das Token verwendet wird. Wird für Besitznachweisflüsse verwendet.

CommonEndSessionRequest

• account - Account-Objekt, von dem abgemeldet wird. Alle token, die an dieses Konto gebunden sind, werden gelöscht.
• postLogoutRedirectUri – URI, zu dem nach der Abmeldeseite navigiert werden soll.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• idTokenHint – ID-Token, das von B2C verwendet wird, um die Abmeldung zu überprüfen, wenn dies durch die Richtlinie erforderlich ist
• state – Ein Wert, der in der Anforderung an den Abmeldungsendpunkt enthalten ist, der bei der Umleitung nach der Abmeldung in der Abfragezeichenfolge zurückgegeben wird
• logoutHint – Eine Zeichenfolge, die das Konto angibt, das abgemeldet wird, um die Serverkontoauswahl beim Abmelden zu überspringen
• extraQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /authorize-Aufruf hinzugefügt wurden

CommonRefreshTokenRequest

• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• Ansprüche – Eine Zeichenfolgenansprücheanforderung, die allen /authorize- und /token-Aufrufen hinzugefügt wird
• authority – URL der Autorität, des Sicherheitstokendiensts (SECURITY Token Service, STS), aus dem MSAL Token abruft.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• refreshToken – Ein Aktualisierungstoken, das von einer vorherigen Anforderung an den Identitätsanbieter zurückgegeben wurde.
• resourceRequestMethod – HTTP-Anforderungstyp, der zum Anfordern von Daten aus der Ressource verwendet wird (z. B. "GET", "POST", usw.). Wird für Besitznachweisflüsse verwendet.
• resourceRequestUri – URI, für den das Token verwendet wird. Wird für Besitznachweisflüsse verwendet.
• forceCache – Erzwingen Sie MSAL, eine Aktualisierungstokenflussantwort zwischenzuspeichern, wenn kein Konto im Cache vorhanden ist. Wird für Migrationsszenarien verwendet.
• tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden

SilentFlow-Parameter, die vom Benutzer übergeben werden, um Anmeldeinformationen im Hintergrund abzurufen

• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• Ansprüche – Eine Zeichenfolgenansprücheanforderung, die allen /authorize- und /token-Aufrufen hinzugefügt wird. Wenn sie in einer automatischen Anforderung enthalten sind, wird die Cachesuche übersprungen, und das Token wird aktualisiert.
• authority – URL der Autorität, von der die Anwendung Token erwirbt.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• Account – Kontoentität zum Nachschlagen der Anmeldeinformationen.
• forceRefresh – Erzwingt automatische Anforderungen zum Tätigen von Netzwerkaufrufen, wenn "true".
• resourceRequestMethod – HTTP-Anforderungstyp, der zum Anfordern von Daten aus der Ressource verwendet wird (z. B. "GET", "POST", usw.). Wird für Besitznachweisflüsse verwendet.
• resourceRequestUri – URI, für den das Token verwendet wird. Wird für Besitznachweisflüsse verwendet.
• tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden

Cachetyp für Anmeldeinformationen

Anmeldeinformationen: <home_account_id*>-<environment-credential_type-client_id-realm<><><>*>-<target*>-<scheme*>

Antwortobjekt, das zum Laden externer Token zum Cache verwendet wird.

• token_type: Gibt den Tokentypwert an. Der einzige Typ, der von Azure AD unterstützt wird, ist Bearer.
• scope: The scopes that the access_token is valid for.
• expires_in: Wie lange das Zugriffstoken gültig ist (in Sekunden).
• id_token: Ein JSON-Webtoken (JWT). Die App kann die Segmente dieses Tokens entschlüsseln, um Informationen über den Benutzer, der sich angemeldet hat, anzufordern.
• refresh_token: Ein OAuth 2.0-Aktualisierungstoken. Die App kann dieses Token verwenden, um zusätzliche Zugriffstoken abzurufen, nachdem das aktuelle Zugriffstoken abgelaufen ist.
• access_token: Das angeforderte Zugriffstoken. Die App kann dieses Token für die Authentifizierung mit der gesicherten Ressource (z. B. einer Web-API) verwenden.
• client_info: Clientinformationsobjekt

Id-Token-Cachetyp

Typ, der das Objekt definiert, das Zeichenfolgen, codiert und im Zustandswert gesendet wird. Enthält Folgendes:

• id – eindeutiger Bezeichner für diese Anforderung
• ts - Zeitstempel für die Zeit, zu der die Anforderung gestellt wurde. Wird verwendet, um sicherzustellen, dass der Ablauf des Tokens nicht falsch berechnet wird.
• platformState – Zeichenfolgenwert, der von der Plattform gesendet wird.

Verwenden Sie diese Option, um die Protokollierung zu konfigurieren, die MSAL ausführt, indem Sie Loggeroptionen im Configuration-Objekt konfigurieren.

• loggerCallback - Rückruf für Logger
• piiLoggingEnabled – Legt fest, ob die Pii-Protokollierung aktiviert ist.
• logLevel – Legt die Ebene fest, auf der die Protokollierung erfolgt.
• correlationId – Legt die korrelations-ID fest, die vom Logger gedruckt wird.

Optionen, die von Netzwerkanforderungs-APIs zulässig sind.

Optionen für den OIDC-Protokollmodus.

Leistungsmessung der Bibliothek, einschließlich Metadaten zur Anforderung und Anwendung.

Der PkceCodes-Typ beschreibt die Struktur von Objekten, die PKCE-Codeabfragen und Verifierpaare enthalten

Warteschlangenmaßtyp

Aktualisierungstokencachetyp

Typ, der das stringified und codierte Objekt definiert, das an den Dienst in der Autorisierungsanforderung gesendet wird.

Typ, der einen eindeutigen Anforderungsfingerabdruck darstellt.

Deserialisiertes Antwortobjekt von der Serverautorisierungscodeanforderung.

• token_type: Gibt den Tokentypwert an. Kann entweder Bearer oder Pop sein.
• scope: The scopes that the access_token is valid for.
• expires_in: Wie lange das Zugriffstoken gültig ist (in Sekunden).
• refresh_in: Dauer, ab der ein Token erneuert werden soll, unabhängig vom Ablauf.
• ext_expires_in: Gibt an, wie lange das Zugriffstoken gültig ist (in Sekunden), wenn der Server nicht reagiert.
• access_token: Das angeforderte Zugriffstoken. Die App kann dieses Token für die Authentifizierung mit der gesicherten Ressource (z. B. einer Web-API) verwenden.
• refresh_token: Ein OAuth 2.0-Aktualisierungstoken. Die App kann dieses Token verwenden, um zusätzliche Zugriffstoken abzurufen, nachdem das aktuelle Zugriffstoken abgelaufen ist.
• id_token: Ein JSON-Webtoken (JWT). Die App kann die Segmente dieses Tokens entschlüsseln, um Informationen über den Benutzer, der sich angemeldet hat, anzufordern.
• key_id: Eine Zeichenfolge, die einen öffentlichen Schlüssel eindeutig identifiziert, an den die Anforderung gebunden ist.

Im Falle eines Fehlers:

• error: Eine Fehlercodezeichenfolge, die verwendet werden kann, um Fehlertypen zu klassifizieren, die auftreten, und kann verwendet werden, um auf Fehler zu reagieren.
• error_description: Eine bestimmte Fehlermeldung, die einem Entwickler dabei helfen kann, die Ursache eines Authentifizierungsfehlers zu identifizieren.
• error_codes: Eine Liste der STS-spezifischen Fehlercodes, die bei der Diagnose hilfreich sein können.
• Zeitstempel: Der Zeitpunkt, zu dem der Fehler aufgetreten ist.
• trace_id: Ein eindeutiger Bezeichner für die Anforderung, die bei der Diagnose hilfreich sein kann.
• correlation_id: Ein eindeutiger Bezeichner für die Anforderung, die bei der Diagnose von Komponenten unterstützt werden kann.
• status: der Antwortstatus der Netzwerkanforderung

Steuert, ob Token im Cache gespeichert werden sollen oder nicht. Wenn dieser Wert auf "false" festgelegt ist, werden Token möglicherweise weiterhin abgerufen und zurückgegeben, werden aber nicht für den späteren Abruf zwischengespeichert.

Key-Value Typ zur Unterstützung von queryParams, extraQueryParams und Ansprüchen

Verwenden Sie diese Einstellung, um Tokenerneuerungsinformationen im Konfigurationsobjekt zu konfigurieren.

• tokenRenewalOffsetSeconds – Legt das Fenster des Offsets fest, das zum Erneuern des Tokens vor Ablauf erforderlich ist.

Kontodetails, die für denselben Benutzer unterschiedlich sind

Typ, der ID-Tokenansprüche beschreibt, die von MSAL bekannt sind.

Input-Objekt für die IAppTokenProvider-Erweiterbarkeit. MSAL erstellt dieses Objekt, das zum Erstellen eines AppTokenProviderResult verwendet werden kann.

• correlationId – die Korrelations-ID, die der Anforderung zugeordnet ist
• tenantId – die Mandanten-ID, für die das Token bereitgestellt werden muss
• Bereiche – die Bereiche, für die das Token bereitgestellt werden muss
• Ansprüche – alle zusätzlichen Ansprüche, die das Token erfüllen muss

Ausgabeobjekt für die IAppTokenProvider-Erweiterbarkeit.

• accessToken – das tatsächliche Zugriffstoken, in der Regel im JWT-Format, das den Anforderungsdaten AppTokenProviderParameters entspricht
• expiresInSeconds – wie lange die Token vor ablaufen, in Sekunden. Ähnlich wie das Feld "expires_in" in einer AAD-Tokenantwort.
• refreshInSeconds – Wie lange das Token hat, bevor es proaktiv aktualisiert werden sollte. Ähnlich wie das Feld "refresh_in" in einer AAD-Tokenantwort.

Client assertions-Anmeldeinformationen für vertrauliche Clients

CommonClientCredentialRequest

• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• authority – URL der Autorität, des Sicherheitstokendiensts (SECURITY Token Service, STS), aus dem MSAL Token abruft.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• skipCache – Überspringen Sie die Tokencachesuche, und erzwingen Sie die Anforderung an die Autorität, um ein neues Token abzurufen. Der Standardwert ist „false“.
• preferredAzureRegionOptions – Optionen der bevorzugten Azure-Region des Benutzers
• tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden

Parameter für den Oauth2-Gerätecodefluss.

• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• authority: - URL der Autorität, der Sicherheitstokendienst (SECURITY Token Service, STS), aus dem MSAL Token erwirbt. Wenn die Autorität für das Clientanwendungsobjekt festgelegt ist, überschreibt dies diesen Wert. Das Überschreiben des Werts bewirkt, dass die Autoritätsüberprüfung jedes Mal erfolgt. Wenn die gleiche Autorität für alle Anforderungen verwendet wird, legen Sie das Anwendungsobjekt anstelle der Anforderungen fest.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• deviceCodeCallback – Rückruf, der die Antwort auf Gerätecode enthält. Die Meldung sollte endbenutzern angezeigt werden. Der Endbenutzer kann dann zum verification_uri navigieren, die user_code eingeben und Anmeldeinformationen eingeben.
• cancel – Boolean to cancel polling of device code endpoint. Während sich der Benutzer auf einem separaten Gerät authentifiziert, fragt MSAL den Tokenendpunkt des Sicherheitstokendiensts für das in der Gerätecodeantwort angegebene Intervall ab (in der Regel 15 Minuten). Wenn Sie die Abfrage beenden und die Anforderung abbrechen möchten, legen Sie "cancel=true" fest.
• resourceRequestMethod – HTTP-Anforderungstyp, der zum Anfordern von Daten aus der Ressource verwendet wird (z. B. "GET", "POST", usw.). Wird für Besitznachweisflüsse verwendet.
• resourceRequestUri – URI, für den das Token verwendet wird. Wird für Besitznachweisflüsse verwendet.
• Timeout – Timeoutzeitraum in Sekunden, den der Benutzer explizit für die Abfrage des Gerätecodeendpunkts konfiguriert. Ende dieses Zeitraums; vorausgesetzt, der Gerätecode ist noch nicht abgelaufen; die Abfrage des Gerätecodes wird beendet und die Anforderung abgebrochen. Das Ablauffenster für Gerätecode hat immer Vorrang vor diesem festgelegten Zeitraum.
• extraQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die der Abfragezeichenfolge hinzugefügt wurden

• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• authority – URL der Autorität, des Sicherheitstokendiensts (SECURITY Token Service, STS), aus dem MSAL Token abruft.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• oboAssertion – Das Zugriffstoken, das an die api der mittleren Ebene gesendet wurde. Dieses Token muss über eine Zielgruppe der App verfügen, die diese OBO-Anforderung stellt.
• skipCache – Überspringen Sie die Tokencachesuche, und erzwingen Sie die Anforderung an die Autorität, um ein neues Token abzurufen. Der Standardwert ist „false“.
• tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden

CommonUsernamePassword-Parameter, die vom Benutzer übergeben werden, um Anmeldeinformationen abzurufen Hinweis: Die neueste bewährte Methode der OAuth 2.0-Sicherheit verbietet die Kennworterteilung vollständig. Dieser Fluss wird für interne Tests hinzugefügt.

• Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
• Ansprüche – Eine Zeichenfolgenansprücheanforderung, die allen /authorize- und /token-Aufrufen hinzugefügt wird. Wenn sie in einer automatischen Anforderung enthalten sind, wird die Cachesuche übersprungen, und das Token wird aktualisiert.
• authority – URL der Autorität, von der die Anwendung Token erwirbt.
• correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
• Benutzername – Benutzername des Clients
• Kennwort – Anmeldeinformationen
• tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden

DeviceCode, der vom Endpunkt des Sicherheitstokendiensts zurückgegeben wird, der Informationen enthält, die für den Gerätecodefluss erforderlich sind.

• userCode: Code, den der Benutzer beim Authentifizieren beim Überprüfungs-URI bereitstellen muss
• deviceCode: Code, der in der Anforderung für das Zugriffstoken enthalten sein soll
• verificationUri: URI, bei dem der Benutzer authentifiziert werden kann
• expiresIn: Ablaufzeit des Gerätecodes in Sekunden
• interval: Interval at which the STS should be polled at
• message: message which should be displayed to the user

Protokollnachrichtenebene.

Status des Leistungsereignisses.

Aufzählung von Vorgängen, die durch ihre Leistung vom PerformanceClient gemessen werden.

Funktion zum Erstellen eines Clientinformationsobjekts aus der ClientInfo-Zeichenfolge des Servers

Funktion zum Erstellen eines Clientinformationsobjekts aus zwischengespeicherter homeAccountId-Zeichenfolge

Erstellen eines Mandantenprofils

Hilfsfunktion zum Umschließen von Browserfehlern in einem CacheError-Objekt

Erstellt einen InteractionRequiredAuthError

Erstellt networkError-Objekt für eine fehlgeschlagene Netzwerkanforderung

Ruft tenantId aus den verfügbaren ID-Tokenansprüchen ab, die als Anmeldeinformationsbereich mit der folgenden Rangfolge festgelegt werden sollen:

1. tid – wenn das Token von einer Azure AD-Mandanten-TID abgerufen wird, vorhanden ist
2. tfp – Wenn das Token von einem modernen B2C-Mandanten-tfp abgerufen wird, sollte vorhanden sein
3. acr – Wenn das Token von einem älteren B2C-Mandanten acr erworben wird, sollte "Downcased" vorhanden sein, um den Anforderungen für den Bereichsvergleich mit der Groß-/Kleinschreibung zu entsprechen.

Gibt true zurück, wenn tenantId dem utid-Teil von homeAccountId entspricht.

Ersetzt Kontoinformationen, die je nach Mandantenprofil, das aus den id-Tokenansprüchen stammt, die durch die mandantenspezifischen Kontoinformationen übergeben werden.

Zeichenfolgenkonstanten im Zusammenhang mit der AAD-Autorität

Typ der Authentifizierungsanforderung

Von MSAL unterstützte Autoritätstypen.

Kontotypen im Cache

Gibt den Grund für das Abrufen des Zugriffstokens vom Identitätsanbieter an.

Alle Cachetypen kombinieren

Anspruchsanforderungsschlüssel

Im Cache gespeicherter Anmeldeinformationstyp

zulässige grant_type

Anforderungsheadernamen

Zulässige Werte für response_type

Parameter für die Kennworterteilung

Persistent cache keys MSAL which stay while user is log in.

Von MSAL unterstützte Protokollmodi.

zulässige Werte für response_mode

Zulässige Werte für den Serverantworttyp

AuthErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden.

Zeichenfolgenkonstanten, die von Fehlercodes und Meldungen verwendet werden.

ClientConfigurationErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden.

zulässige Werte für codeVerifier

Vom SDK definierte Fehler bei der Interaktion

wir haben diese "Enumeration" in der Anforderung anstelle von Zeichenfolgen festgelegt, es sieht jedoch so aus, als ob die Liste der zulässigen Eingabeaufforderungswerte in den letzten Jahren geändert wurde. Es gibt auch einige nicht dokumentierte Eingabeaufforderungswerte für einige interne Partner, daher die Wahl des generischen "string"-Typs anstelle der "Enumeration"

Konstanten im Zusammenhang mit Drosselung