@azure/msal-node package

Klassen

AuthError

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

ClientApplication

Basis-abstrakte Klasse für alle ClientApplications – öffentlich und vertraulich

ClientAssertion

Client assertion vom Typ jwt-bearer, der in vertraulichen Clientflüssen verwendet wird

ClientAuthError

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

ClientConfigurationError

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

ClientCredentialClient

Genehmigung von OAuth2.0-Clientanmeldeinformationen

ConfidentialClientApplication

Diese Klasse dient zum Abrufen von Token für vertrauliche Clientanwendungen (webApp, webAPI). Vertrauliche Clientanwendungen konfigurieren anwendungsgeheimnisse, Clientzertifikate/Assertionen wie zutreffend

CryptoProvider

Diese Klasse implementiert die Kryptoschnittstelle des MSAL-Knotens, die es ermöglicht, base64-Codierung und Decodierung durchzuführen, kryptografisch zufällige GUIDs zu generieren und Proof Key für Code Exchange Spezifikationen für den OAuth-Autorisierungscodefluss mithilfe von PKCE (rfc: ) zu implementieren. https://tools.ietf.org/html/rfc7636

DeviceCodeClient

OAuth2.0-Gerätecodeclient

DistributedCachePlugin

Cache-Plug-In, das Daten in den Cache serialisiert und Daten aus dem Cache deserialisiert

InteractionRequiredAuthError

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

Logger

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

ManagedIdentityApplication

Klasse zum Initialisieren einer verwalteten Identität und Identifizieren des Diensts

OnBehalfOfClient

On-Behalf-Of Client

PublicClientApplication

Diese Klasse wird verwendet, um Token für öffentliche Clientanwendungen (Desktop, Mobil) zu erwerben. Öffentliche Clientanwendungen sind nicht vertrauenswürdig, um geheime Anwendungsschlüssel sicher zu speichern, und daher können nur Token im Namen eines Benutzers angefordert werden.

ServerError

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

TokenCache

Cache-Manager für In-Memory-Token

TokenCacheContext

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

UsernamePasswordClient

Oauth2.0-Clienthinweis zur Kennworterteilung: Wir unterstützen nur öffentliche Clients für die Kennworterteilung und ausschließlich zu Testzwecken.

Schnittstellen

IAppTokenProvider
ICacheClient

Schnittstelle für den Cache, der einen Getter und Setter definiert

ICachePlugin
IConfidentialClientApplication

Schnittstelle für die ConfidentialClientApplication-Klasse, die die öffentlichen API-Signaturen definiert

ILoopbackClient

Schnittstelle für LoopbackClient, mit der der Standard-Loopbackserver durch eine benutzerdefinierte Implementierung ersetzt werden kann.

INativeBrokerPlugin
INetworkModule

Clientnetzwerkschnittstelle zum Senden von Back-End-Anforderungen.

IPartitionManager

Schnittstelle, die getter-Methoden definiert, um Schlüssel abzurufen, die für Identitätsdaten im Cache verwendet werden

IPublicClientApplication

Schnittstelle für die PublicClientApplication-Klasse, die die öffentlichen API-Signaturen definiert

ISerializableTokenCache
ITokenCache

Tokencacheschnittstelle für den Client, wodurch Der Zugriff auf Cache-APIs ermöglicht wird

Typaliase

AccountInfo

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
AppTokenProviderParameters

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
AppTokenProviderResult

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.
AuthenticationResult

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
AuthorizationCodePayload

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

AuthorizationCodeRequest

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.
  • tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden
  • 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
  • state – Eindeutige GUID, die vom Benutzer generiert wird, der vom Benutzer zwischengespeichert und während des ersten Abschnitts des Flusses an den Server gesendet wird. Diese Zeichenfolge wird vom Server mit dem Autorisierungscode zurückgesendet. Der zwischengespeicherte Zustand des Benutzers wird dann mit dem vom Server empfangenen Zustand verglichen, um das Risiko von CSRF-Angriffen zu verringern. Siehe https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.
AuthorizationUrlRequest

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 weiter.
  • 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 Aufruf "/authorize" 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.
AuthorizeResponse

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

AzureCloudOptions

Spezifische AzureCloudInstance-Optionen

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

Verwenden Sie diese Option, um die folgenden Brokeroptionen zu konfigurieren:

  • nativeBrokerPlugin – Native Broker-Implementierung (sollte aus msal-node-extensions importiert werden)

Hinweis: Diese Optionen sind nur für PublicClientApplications mit dem Autorisierungscodefluss verfügbar.

CacheKVStore

Schlüsselwertspeicher für speicherinternen Cache

CacheOptions

Verwenden Sie diese Option, um die folgenden Cachekonfigurationsoptionen zu konfigurieren:

  • cachePlugin – Plug-In zum Lesen und Schreiben des Tokencaches auf den Datenträger.
ClientAssertionCallback
ClientCredentialRequest

CommonClientCredentialRequest

  • Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert. Enthält in der Regel nur den Standardbereich für eine einzelne Ressource. Siehe: https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc#the-default-scope
  • 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“.
  • clientAssertion – Eine Assertionszeichenfolge oder eine Rückruffunktion, die eine Assertionszeichenfolge zurückgibt (beide sind base64Url-codierte signierte JWTs), die im Client-Anmeldeinformationsfluss verwendet werden
  • tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden
Configuration

Verwenden des Konfigurationsobjekts zum Konfigurieren von MSAL und Initialisieren des Clientanwendungsobjekts

  • Authentifizierung: Hier konfigurieren Sie Authentifizierungselemente wie clientID, Autorität für die Authentifizierung für die Microsoft Identity Platform
  • Broker: Hier konfigurieren Sie Brokeroptionen.
  • cache: Hier konfigurieren Sie den Cachespeicherort.
  • System: Hier können Sie den Netzwerkclient konfigurieren, Logger
  • Telemetrie: Hier können Sie Telemetrieoptionen konfigurieren.
DeviceCodeRequest

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.
  • extraQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die der Abfragezeichenfolge hinzugefügt wurden
IdTokenClaims

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

InMemoryCache

Intermittierender Typ zum Behandeln von In-Memory-Datenobjekten mit definierten Typen

InteractiveRequest

Vom Benutzer übergebenes Anforderungsobjekt zum Konfigurieren der AcquireTokenInteractive-API

  • openBrowser – Funktion zum Öffnen einer Browserinstanz im System des Benutzers.
  • Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
  • successTemplate: - Vorlage, die bei erfolgreicher Tokenerfassung auf der geöffneten Browserinstanz angezeigt werden soll.
  • errorTemplate – Vorlage, die bei Einem Tokenerwerbsfehler in der geöffneten Browserinstanz angezeigt werden soll.
  • windowHandle – Wird in systemeigenen Brokerflüssen verwendet, um das systemeigene Brokerfenster ordnungsgemäß zu übergeordneten Elementen zu verwenden
  • loopbackClient – Benutzerdefinierte Implementierung für einen Loopbackserver, um auf die Autorisierungscodeantwort zu lauschen.
JsonCache

Cacheformatlesevorgang aus dem Cache-BLOB, das während der App-Instanziierung für die Konfiguration bereitgestellt wird

ManagedIdentityConfiguration
ManagedIdentityIdParams
ManagedIdentityRequestParams

ManagedIdentityRequest

  • Ansprüche – eine Zeichenfolgenanforderung, die verwendet wird, um zu bestimmen, ob der Cache übersprungen werden soll.
  • forceRefresh – erzwingt verwaltete Identitätsanforderungen, den Cache zu überspringen und Netzwerkaufrufe auszuführen, wenn wahr
  • ressource – Ressource, die für den Zugriff auf die geschützte API angefordert wurde. Dies sollte das Format "ResourceIdUri" oder "ResourceIdUri/.default" sein. Beispielsweise https://management.azure.net für Microsoft Graphhttps://graph.microsoft.com/.default
NetworkRequestOptions

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

NetworkResponse
NodeAuthOptions
  • clientId – Client-ID der Anwendung.
  • authority - URL der Autorität. Wenn kein Wert festgelegt ist, wird standardmäßig auf https://login.microsoftonline.com/common.
  • knownAuthorities – Erforderlich für Azure B2C und ADFS. Alle Behörden, die in der Clientanwendung verwendet werden. Nur der Host der Behörde sollte übergeben werden.
  • clientSecret – Geheime Zeichenfolge, die die Anwendung beim Anfordern eines Tokens verwendet. Wird nur in vertraulichen Clientanwendungen verwendet. Kann im Azure App-Registrierungsportal erstellt werden.
  • clientAssertion – Ein ClientAssertion-Objekt, das eine Assertionszeichenfolge oder eine Rückruffunktion enthält, die eine Assertionszeichenfolge zurückgibt, die die Anwendung beim Anfordern eines Tokens verwendet, sowie den Typ der Assertion (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Wird nur in vertraulichen Clientanwendungen verwendet.
  • clientCertificate – Zertifikat, das die Anwendung beim Anfordern eines Tokens verwendet. Wird nur in vertraulichen Clientanwendungen verwendet. Erfordert hexcodierte X.509 SHA-1- oder SHA-256-Fingerabdruck des Zertifikats und den PEM-codierten privaten Schlüssel (Zeichenfolge sollte -----BEGIN PRIVATE KEY enthalten----- ... -----END PRIVATE SCHLÜSSEL----- )
  • protocolMode - Enum, das das folgende Protokoll darstellt. Wird zum Konfigurieren der richtigen Endpunkte verwendet.
  • skipAuthorityMetadataCache – Ein Flag zum Auswählen, ob der lokale Metadatencache während der Autorisierungsinitialisierung verwendet werden soll oder nicht. Der Standardwert ist „false“.
  • encodeExtraQueryParams – Ein Flag, um auszuwählen, ob zusätzliche Abfrageparameter in der Anforderungs-URL codiert werden sollen. Der Standardwert ist „false“.
NodeSystemOptions

Typ zum Konfigurieren von Logger- und HTTP-Clientoptionen

  • Logger - Wird verwendet, um das Logger-Objekt zu initialisieren; TODO: Erweitern Sie die Loggerdetails, oder verknüpfen Sie die Dokumentation auf Logger
  • networkClient – Http-Client, der für alle HTTP-Abrufe und Postanrufe verwendet wird. Standardmäßig wird der Standardmäßige HTTP-Client von MSAL verwendet.
NodeTelemetryOptions
OnBehalfOfRequest
  • 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
RefreshTokenRequest

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.
  • tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden
  • forceCache – Erzwingen Sie MSAL, eine Aktualisierungstokenflussantwort zwischenzuspeichern, wenn kein Konto im Cache vorhanden ist. Wird für Migrationsszenarien verwendet.
SerializedAccessTokenEntity

Zugriffstoken-Anmeldeinformationstyp

SerializedAccountEntity

Kontotyp

SerializedAppMetadataEntity

AppMetadata-Typ

SerializedIdTokenEntity

Idtoken-Anmeldeinformationstyp

SerializedRefreshTokenEntity

Aktualisierungstoken-Anmeldeinformationstyp

SignOutRequest
SilentFlowRequest

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.
  • tokenQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die dem /token-Aufruf hinzugefügt wurden
  • Account – Kontoentität zum Nachschlagen der Anmeldeinformationen.
  • forceRefresh – Erzwingt automatische Anforderungen zum Tätigen von Netzwerkaufrufen, wenn "true".
UsernamePasswordRequest

UsernamePassword-Parameter, die vom Benutzer übergeben werden, um Anmeldeinformationen abzurufen Hinweis: Die neueste bewährte OAuth 2.0 Security Best Current Practice 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

Enumerationen

LogLevel

Protokollnachrichtenebene.

Variablen

AzureCloudInstance
ManagedIdentitySourceNames

Namen der verwalteten Identitätsquelle

ProtocolMode

Von MSAL unterstützte Protokollmodi.

ResponseMode

zulässige Werte für response_mode

AuthErrorMessage

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

ClientAuthErrorMessage

Zeichenfolgenkonstanten, die von Fehlercodes und Meldungen verwendet werden.

ClientConfigurationErrorMessage

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

InteractionRequiredAuthErrorMessage

Vom SDK definierte Fehler bei der Interaktion

PromptValue

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"

version

Details zu Variablen

AzureCloudInstance

AzureCloudInstance: { AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

Typ

{ AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

ManagedIdentitySourceNames

Namen der verwalteten Identitätsquelle

ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }

Typ

{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }

ProtocolMode

Von MSAL unterstützte Protokollmodi.

ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

Typ

{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

ResponseMode

zulässige Werte für response_mode

ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

Typ

{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

AuthErrorMessage

Warnung

Diese API ist nun veraltet.

Use AuthErrorCodes instead

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

AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

Typ

{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

ClientAuthErrorMessage

Warnung

Diese API ist nun veraltet.

Use ClientAuthErrorCodes instead

Zeichenfolgenkonstanten, die von Fehlercodes und Meldungen verwendet werden.

ClientAuthErrorMessage: { DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

Typ

{ DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

ClientConfigurationErrorMessage

Warnung

Diese API ist nun veraltet.

Use ClientConfigurationErrorCodes instead

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

ClientConfigurationErrorMessage: { authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

Typ

{ authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

InteractionRequiredAuthErrorMessage

Warnung

Diese API ist nun veraltet.

Use InteractionRequiredAuthErrorCodes instead

Vom SDK definierte Fehler bei der Interaktion

InteractionRequiredAuthErrorMessage: { bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

Typ

{ bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

PromptValue

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"

PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

Typ

{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

version

version: "3.8.10"

Typ

"3.8.10"