@azure/msal-node package

Klassen

AuthError

Algemene foutklasse die is gegenereerd door de MSAL.js-bibliotheek.

ClientApplication

Abstracte basisklasse voor alle ClientApplications - openbaar en vertrouwelijk

ClientAssertion

Clientverklaring van het type jwt-bearer dat wordt gebruikt in vertrouwelijke clientstromen

ClientAuthError

Er is een fout opgetreden wanneer er een fout optreedt in de clientcode die wordt uitgevoerd in de browser.

ClientConfigurationError

Er is een fout opgetreden wanneer er een fout optreedt in de configuratie van de MSAL.js-bibliotheek.

ClientCredentialClient

OAuth2.0-clientreferentie verlenen

ConfidentialClientApplication

Deze klasse moet worden gebruikt voor het verkrijgen van tokens voor vertrouwelijke clienttoepassingen (webApp, webAPI). Vertrouwelijke clienttoepassingen configureren toepassingsgeheimen, clientcertificaten/asserties indien van toepassing

CryptoProvider

Deze klasse implementeert de crypto-interface van het MSAL-knooppunt, waarmee het base64-codering en -decodering kan uitvoeren, cryptografisch willekeurige GUID's genereert en proof key for Code Exchange specificaties voor de OAuth-autorisatiecodestroom implementeert met behulp van PKCE (rfc hier: https://tools.ietf.org/html/rfc7636).

DeviceCodeClient

OAuth2.0-apparaatcodeclient

DistributedCachePlugin

Cache-invoegtoepassing waarmee gegevens naar de cache worden geserialiseerd en gegevens uit de cache worden gedeserialiseerd

InteractionRequiredAuthError

Er is een fout opgetreden wanneer gebruikersinteractie is vereist.

Logger

Klasse die het vastleggen van berichten naar een specifieke locatie vereenvoudigt.

ManagedIdentityApplication

Klasse voor het initialiseren van een beheerde identiteit en het identificeren van de service

OnBehalfOfClient

On-Behalf-Of-client

PublicClientApplication

Deze klasse moet worden gebruikt voor het verkrijgen van tokens voor openbare clienttoepassingen (desktop, mobiel). Openbare clienttoepassingen worden niet vertrouwd om toepassingsgeheimen veilig op te slaan en kunnen daarom alleen tokens aanvragen in de naam van een gebruiker.

ServerError

Er is een fout opgetreden wanneer er een fout optreedt met de servercode, bijvoorbeeld niet beschikbaar.

TokenCache

Cachebeheer voor tokens in het geheugen

TokenCacheContext

Dit klasse-exemplaar helpt bij het bijhouden van de geheugenwijzigingen, waardoor beslissingen kunnen worden gelezen van en geschreven naar de permanente cache

UsernamePasswordClient

Oauth2.0 Password grant client Opmerking: we ondersteunen alleen openbare clients voor het verlenen van wachtwoorden en voor uitsluitend testdoeleinden

Interfaces

IAppTokenProvider
ICacheClient

Interface voor de cache die een getter en setter definieert

ICachePlugin
IConfidentialClientApplication

Interface voor de Klasse ConfidentialClientApplication waarmee de openbare API-handtekeningen worden gedefinieerd

ILoopbackClient

Interface voor LoopbackClient waarmee de standaard loopbackserver kan worden vervangen door een aangepaste implementatie.

INativeBrokerPlugin
INetworkModule

Clientnetwerkinterface voor het verzenden van back-endaanvragen.

IPartitionManager

Interface waarmee getter-methoden worden gedefinieerd om sleutels op te halen die worden gebruikt voor identiteitsgegevens in de cache

IPublicClientApplication

Interface voor de PublicClientApplication-klasse die de openbare API-handtekeningen definieert

ISerializableTokenCache
ITokenCache

Tokencacheinterface voor de client, waardoor toegang wordt gegeven tot cache-API's

Type-aliassen

AccountInfo

Accountobject met de volgende handtekening:

  • homeAccountId - Home-account-id voor dit accountobject
  • omgeving: entiteit die het token heeft uitgegeven dat wordt vertegenwoordigd door het domein van de verlener (bijvoorbeeld login.microsoftonline.com)
  • tenantId : volledige tenant- of organisatie-id waartoe dit account behoort
  • gebruikersnaam : preferred_username claim van de id_token die dit account vertegenwoordigt
  • localAccountId - Lokaal, tenantspecifiek accountidentifer voor dit accountobject, meestal gebruikt in verouderde gevallen
  • name - Volledige naam voor het account, inclusief de voornaam en familienaam
  • idToken - onbewerkt id-token
  • idTokenClaims - Object bevat claims van id-token
  • nativeAccountId - De systeemeigen account-id van de gebruiker
  • tenantProfiles - Toewijzing van tenantprofielobjecten voor elke tenant waarmee het account is geverifieerd in de browser
  • dataBoundary - Gegevensgrens geëxtraheerd uit clientInfo
AppTokenProviderParameters

Invoerobject voor de uitbreiding van IAppTokenProvider. MSAL maakt dit object, dat kan worden gebruikt om een AppTokenProviderResult te maken.

  • correlationId: de correlatie-id die is gekoppeld aan de aanvraag
  • tenantId: de tenant-id waarvoor het token moet worden opgegeven
  • bereiken: de bereiken waarvoor het token moet worden opgegeven
  • claims- eventuele extra claims waaraan het token moet voldoen
AppTokenProviderResult

Uitvoerobject voor IAppTokenProvider extensiblity.

  • accessToken: het werkelijke toegangstoken, meestal in JWT-indeling, dat voldoet aan de aanvraaggegevens AppTokenProviderParameters
  • expiresInSeconds - hoe lang de tokens vóór de vervaldatum, in seconden. Vergelijkbaar met het veld 'expires_in' in een AAD-tokenantwoord.
  • refreshInSeconds: hoe lang het token heeft voordat het proactief moet worden vernieuwd. Vergelijkbaar met het veld 'refresh_in' in een AAD-tokenantwoord.
AuthenticationResult

Resultaat geretourneerd van het tokeneindpunt van de instantie.

  • uniqueId - oid of sub claim van id-token
  • tenantId - tid claim van id-token
  • bereiken - Bereiken die worden gevalideerd voor het respectieve token
  • account - Een accountobjectweergave van de momenteel aangemelde gebruiker
  • idToken - Id-token dat is ontvangen als onderdeel van het antwoord
  • idTokenClaims - MSAL-relevante id-tokenclaims
  • accessToken - Toegangstoken of SSH-certificaat dat is ontvangen als onderdeel van het antwoord
  • fromCache - Booleaanse waarde die aangeeft of het token afkomstig is uit de cache
  • expiresOn - JavaScript-datumobject dat de relatieve vervaldatum van het toegangstoken vertegenwoordigt
  • extExpiresOn - JavaScript-datumobject dat een uitgebreide relatieve vervaldatum van het toegangstoken vertegenwoordigt in het geval van een serverstoring
  • refreshOn - JavaScript-datumobject dat de relatieve tijd aangeeft totdat een toegangstoken moet worden vernieuwd
  • state - Waarde doorgegeven door gebruiker in aanvraag
  • familyId - Family ID-id, meestal alleen gebruikt voor vernieuwingstokens
  • requestId - Aanvraag-id geretourneerd als onderdeel van het antwoord
AuthorizationCodePayload

Antwoord geretourneerd na het verwerken van de querytekenreeks of het fragment van het codeantwoord.

AuthorizationCodeRequest

Aanvraagobject dat door de gebruiker is doorgegeven om een token te verkrijgen van de server die een geldige autorisatiecode uitwisselt (tweede deel van OAuth2.0-autorisatiecodestroom)

  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • claims - Een tekenreeksclaimaanvraag die wordt toegevoegd aan alle aanroepen /authorize en /token
  • instantie: - URL van de instantie, de beveiligingstokenservice (STS) van waaruit MSAL tokens zal verkrijgen. Als de instantie is ingesteld voor clienttoepassingsobject, wordt deze waarde overschreven. Als u de waarde overschrijft, wordt de validatie van de instantie elke keer uitgevoerd. Als dezelfde instantie wordt gebruikt voor alle aanvragen, stelt u het toepassingsobject in plaats van de aanvragen in.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • redirectUri: de omleidings-URI van uw app, waar de instantie wordt omgeleid nadat de gebruikersreferenties en toestemmingen hebben ingevoerd. Deze moet exact overeenkomen met een van de omleidings-URI's die u hebt geregistreerd in de portal.
  • tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token
  • code: de authorization_code die de gebruiker heeft verkregen in het eerste deel van de stroom.
  • codeVerifier: dezelfde code_verifier die is gebruikt om de authorization_code te verkrijgen. Vereist als PKCE is gebruikt in de aanvraag voor het verlenen van autorisatiecode. Zie de PKCE RFC voor meer informatie: https://tools.ietf.org/html/rfc7636
  • status: unieke GUID die is gegenereerd door de gebruiker die in de cache wordt opgeslagen door de gebruiker en tijdens het eerste deel van de stroom naar de server wordt verzonden. Deze tekenreeks wordt teruggestuurd door de server met de autorisatiecode. De status in de cache van de gebruiker wordt vervolgens vergeleken met de status die van de server is ontvangen om het risico van CSRF-aanvallen te beperken. Zie https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.
AuthorizationUrlRequest

Aanvraagobject dat door de gebruiker is doorgegeven om een code op te halen van de server (eerste been van autorisatiecode verlenen stroom)

  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • claims - Een tekenreeksclaimaanvraag die wordt toegevoegd aan alle aanroepen /authorize en /token
  • authority: URL van de instantie waarvan de toepassing tokens verkrijgt.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • redirectUri: de omleidings-URI waar verificatiereacties kunnen worden ontvangen door uw toepassing. Deze moet exact overeenkomen met een van de omleidings-URI's die zijn geregistreerd in de Azure-portal.
  • extraScopesToConsent - Bereiken voor een andere resource wanneer de gebruiker vooraf toestemming nodig heeft.
  • responseMode: hiermee geeft u de methode op die moet worden gebruikt om het verificatieresultaat naar uw app te verzenden. Kan query's, form_post of fragmenten zijn. Als er geen waarde wordt doorgegeven, wordt er standaard een query uitgevoerd.
  • codeChallenge - Wordt gebruikt om autorisatiecodetoekenningen te beveiligen via Proof of Key for Code Exchange (PKCE). Zie de PKCE RCF voor meer informatie:https://tools.ietf.org/html/rfc7636
  • codeChallengeMethod: de methode die wordt gebruikt om de codeverificator te coderen voor de parameter voor de codevraag. Kan 'eenvoudig' of 'S256' zijn. Als deze optie is uitgesloten, wordt ervan uitgegaan dat code-uitdaging tekst zonder opmaak is. Zie de PKCE RCF voor meer informatie: https://tools.ietf.org/html/rfc7636
  • status: een waarde die is opgenomen in de aanvraag die ook wordt geretourneerd in het tokenantwoord. Een willekeurig gegenereerde unieke waarde wordt doorgaans gebruikt voor het voorkomen van vervalsingsaanvallen op meerdere sites. De status wordt ook gebruikt om informatie over de status van de gebruiker in de app te coderen voordat de verificatieaanvraag is opgetreden.
  • prompt- Geeft het type gebruikersinteractie aan dat is vereist. login: dwingt de gebruiker om hun referenties op die aanvraag in te voeren, waarbij eenmalige aanmelding wordt genegeerd: zorgt ervoor dat de gebruiker geen interactieve prompt wordt weergegeven. als de aanvraag niet kan worden voltooid via eenmalige aanmelding, retourneert het eindpunt een interaction_required fouttoestemming: wordt het dialoogvenster OAuth-toestemming geactiveerd nadat de gebruiker zich heeft aangemeld, waarbij de gebruiker wordt gevraagd om machtigingen te verlenen aan de app select_account: onderbreekt eenmalige aanmelding=bij het bieden van een accountselectieervaring met alle accounts in een sessie of onthouden accounts of een optie om een ander account te gebruiken: leidt de gebruiker naar de ervaring voor het maken van accounts in plaats van de aanmeldingservaring
  • account - AccountInfo verkregen via een getAccount-API. Wordt gebruikt in bepaalde scenario's om login_hint te genereren als er geen aanmeldingshint- en sid-parameters worden opgegeven.
  • loginHint: kan worden gebruikt om het veld gebruikersnaam/e-mailadres van de aanmeldingspagina voor de gebruiker vooraf in te vullen, als u de gebruikersnaam/het e-mailadres van tevoren kent. Apps gebruiken deze parameter vaak tijdens opnieuw verificatie, nadat de gebruikersnaam al is geëxtraheerd uit een vorige aanmelding met behulp van de claim preferred_username.
  • sid : sessie-id, unieke id voor de sessie. Beschikbaar als een optionele claim voor id-tokens.
  • domainHint: biedt een hint over de tenant of het domein dat de gebruiker moet gebruiken om zich aan te melden. De waarde van de domeinhint is een geregistreerd domein voor de tenant.
  • extraQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /authorize
  • tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token
  • nonce: een waarde die is opgenomen in de aanvraag die wordt geretourneerd in het id-token. Een willekeurig gegenereerde unieke waarde wordt doorgaans gebruikt om herhalingsaanvallen te beperken.
AuthorizeResponse

Antwoordeigenschappen die kunnen worden geretourneerd door het /authorize-eindpunt

AzureCloudOptions

Specifieke opties voor AzureCloudInstance

  • azureCloudInstance - string enum die korte notatie biedt voor soverign- en openbare cloudautoriteiten
  • tenant - inrichten om de tenantgegevens op te geven
BrokerOptions

Gebruik deze optie om de onderstaande brokeropties te configureren:

  • nativeBrokerPlugin - Native Broker-implementatie (moet worden geïmporteerd vanuit msal-node-extensions)

Opmerking: deze opties zijn alleen beschikbaar voor PublicClientApplications met behulp van de autorisatiecodestroom

CacheKVStore

Sleutelwaardearchief voor cache in het geheugen

CacheOptions

Gebruik deze optie om de onderstaande cacheconfiguratieopties te configureren:

  • cachePlugin - Invoegtoepassing voor het lezen en schrijven van tokencache naar schijf.
ClientAssertionCallback
ClientCredentialRequest

CommonClientCredentialRequest

  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt. Bevat doorgaans alleen het standaardbereik voor één resource. Zie: https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc#the-default-scope
  • authority- URL van de instantie, de beveiligingstokenservice (STS) van waaruit MSAL tokens zal verkrijgen.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • skipCache- Sla het opzoeken van tokencache over en forceer aanvragen om een nieuw token op te halen. Standaard ingesteld op onwaar.
  • clientAssertion: een assertietekenreeks of een callback-functie die een assertietekenreeks retourneert (beide base64Url-gecodeerde ondertekende JWT's) die worden gebruikt in de clientreferentiestroom
  • tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token
Configuration

Het configuratieobject gebruiken om MSAL te configureren en het clienttoepassingsobject te initialiseren

  • auth: hier configureert u verificatie-elementen zoals clientID, instantie die wordt gebruikt voor verificatie op basis van het Microsoft Identity Platform
  • broker: hier configureert u brokeropties
  • cache: hier configureert u de cachelocatie
  • systeem: hier kunt u de netwerkclient, logger configureren
  • telemetrie: hier kunt u telemetrieopties configureren
DeviceCodeRequest

Parameters voor de Oauth2-apparaatcodestroom.

  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • instantie: - URL van de instantie, de beveiligingstokenservice (STS) van waaruit MSAL tokens zal verkrijgen. Als de instantie is ingesteld voor clienttoepassingsobject, wordt deze waarde overschreven. Als u de waarde overschrijft, wordt de validatie van de instantie elke keer uitgevoerd. Als dezelfde instantie wordt gebruikt voor alle aanvragen, stelt u het toepassingsobject in plaats van de aanvragen in.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • deviceCodeCallback - Callback met antwoord op apparaatcode. Het bericht moet worden weergegeven aan de eindgebruiker. Eindgebruikers kunnen vervolgens naar de verification_uri navigeren, de user_code en invoerreferenties invoeren.
  • cancel - Booleaanse waarde om polling van eindpunt van apparaatcode te annuleren. Terwijl de gebruiker zich verifieert op een afzonderlijk apparaat, controleert MSAL het tokeneindpunt van de beveiligingstokenservice voor het interval dat is opgegeven in het antwoord op de apparaatcode (meestal 15 minuten). Als u de polling wilt stoppen en de aanvraag wilt annuleren, stelt u cancel=true in.
  • extraQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de querytekenreeks
IdTokenClaims

Type waarmee id-tokenclaims worden beschreven die bekend zijn door MSAL.

InMemoryCache

Onregelmatig type voor het verwerken van in-memory gegevensobjecten met gedefinieerde typen

InteractiveRequest

Aanvraagobject dat door de gebruiker is doorgegeven om acquireTokenInteractive API te configureren

  • openBrowser - Functie om een browserexemplaren te openen op het systeem van de gebruiker.
  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • successTemplate: - Sjabloon die moet worden weergegeven op het geopende browserexemplaren bij geslaagde overname van tokens.
  • errorTemplate: sjabloon die moet worden weergegeven op het geopende browserexemplaren bij het verkrijgen van tokens.
  • windowHandle - Wordt gebruikt in systeemeigen brokerstromen om het systeemeigen brokervenster goed te laten bovenliggen
  • loopbackClient : aangepaste implementatie voor een loopback-server om te luisteren naar antwoord van autorisatiecode.
JsonCache

Cache-indeling gelezen uit de cache-blob die tijdens de app-instantiëring aan de configuratie is verstrekt

ManagedIdentityConfiguration
ManagedIdentityIdParams
ManagedIdentityRequestParams

ManagedIdentityRequest

  • claims: een aanvraag voor tekenreeksclaims die wordt gebruikt om te bepalen of de cache al dan niet moet worden overgeslagen
  • forceRefresh : dwingt beheerde identiteitsaanvragen af om de cache over te slaan en netwerkaanroepen uit te voeren als waar
  • resource: resource die is aangevraagd voor toegang tot de beveiligde API. Dit moet het formulier ResourceIdUri of ResourceIdUri/.default hebben. Bijvoorbeeldhttps://management.azure.net, voor Microsoft Graph,https://graph.microsoft.com/.default
NetworkRequestOptions

Opties die zijn toegestaan door API's voor netwerkaanvragen.

NetworkResponse
NodeAuthOptions
  • clientId - Client-id van de toepassing.
  • authority - URL van de instantie. Als er geen waarde is ingesteld, wordt standaard ingesteld op https://login.microsoftonline.com/common.
  • knownAuthorities - Vereist voor Azure B2C en ADFS. Alle instanties die worden gebruikt in de clienttoepassing. Alleen de host van de instantie moet worden doorgegeven.
  • clientSecret: geheime tekenreeks die door de toepassing wordt gebruikt bij het aanvragen van een token. Alleen gebruikt in vertrouwelijke clienttoepassingen. Kan worden gemaakt in de Azure portal voor app-registratie.
  • clientAssertion : een ClientAssertion-object met een assertietekenreeks of een callback-functie die een assertietekenreeks retourneert die door de toepassing wordt gebruikt bij het aanvragen van een token, evenals het type van de assertie (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Alleen gebruikt in vertrouwelijke clienttoepassingen.
  • clientCertificate: certificaat dat de toepassing gebruikt bij het aanvragen van een token. Alleen gebruikt in vertrouwelijke clienttoepassingen. Vereist hex gecodeerde X.509 SHA-1- of SHA-256-vingerafdruk van het certificaat en de met PEM gecodeerde persoonlijke sleutel (tekenreeks moet -----BEGIN PRIVATE KEY bevatten----- ... -----END PRIVATE KEY----- )
  • protocolMode - Enum dat het protocol vertegenwoordigt dat msal volgt. Wordt gebruikt voor het configureren van de juiste eindpunten.
  • skipAuthorityMetadataCache: een vlag om te kiezen of u de lokale metagegevenscache wilt gebruiken tijdens het initialiseren van de instantie. Standaard ingesteld op onwaar.
  • encodeExtraQueryParams : een vlag om te kiezen of u extra queryparameters in de aanvraag-URL wilt coderen. Standaard ingesteld op onwaar.
NodeSystemOptions

Type voor het configureren van logboekregistratie en http-clientopties

  • logger - Wordt gebruikt om het Logger-object te initialiseren; TODO: Meer informatie over logboekregistratie of koppeling naar de documentatie over logboekregistratie
  • networkClient : Http-client die wordt gebruikt voor alle http get- en post-aanroepen. Standaard wordt de standaard-HTTP-client van MSAL gebruikt.
NodeTelemetryOptions
OnBehalfOfRequest
  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • authority- URL van de instantie, de beveiligingstokenservice (STS) van waaruit MSAL tokens zal verkrijgen.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • oboAssertion : het toegangstoken dat is verzonden naar de API in de middelste laag. Dit token moet een doelgroep hebben van de app die deze OBO-aanvraag doet.
  • skipCache- Sla het opzoeken van tokencache over en forceer aanvragen om een nieuw token op te halen. Standaard ingesteld op onwaar.
  • tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token
RefreshTokenRequest

CommonRefreshTokenRequest

  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • claims - Een tekenreeksclaimaanvraag die wordt toegevoegd aan alle aanroepen /authorize en /token
  • authority- URL van de instantie, de beveiligingstokenservice (STS) van waaruit MSAL tokens zal verkrijgen.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • refreshToken: een vernieuwingstoken dat is geretourneerd van een vorige aanvraag naar de id-provider.
  • tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token
  • forceCache: dwing MSAL af om een reactie van een vernieuwingstokenstroom in de cache op te cachen wanneer er geen account in de cache is. Wordt gebruikt voor migratiescenario's.
SerializedAccessTokenEntity

Referentietype toegangstoken

SerializedAccountEntity

Rekeningstype

SerializedAppMetadataEntity

AppMetadata-type

SerializedIdTokenEntity

Referentietype Idtoken

SerializedRefreshTokenEntity

Referentietype token vernieuwen

SignOutRequest
SilentFlowRequest

SilentFlow-parameters doorgegeven door de gebruiker om referenties op de achtergrond op te halen

  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • claims- Een tekenreeksclaimaanvraag die wordt toegevoegd aan alle aanroepen /authorize en /token. Wanneer dit is opgenomen in een stille aanvraag, wordt cachezoekactie overgeslagen en wordt het token vernieuwd.
  • authority: URL van de instantie waarvan de toepassing tokens verkrijgt.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token
  • account - Accountentiteit om de referenties op te zoeken.
  • forceRefresh : dwingt stille aanvragen af om netwerkaanroepen uit te voeren, indien waar.
UsernamePasswordRequest

UsernamePassword-parameters die door de gebruiker zijn doorgegeven om referenties op te halen Opmerking: de meest recente best practice voor beveiliging van OAuth 2.0 staat de toekenning van het wachtwoord volledig toe. Deze stroom wordt toegevoegd voor interne tests.

  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • claims- Een tekenreeksclaimaanvraag die wordt toegevoegd aan alle aanroepen /authorize en /token. Wanneer dit is opgenomen in een stille aanvraag, wordt cachezoekactie overgeslagen en wordt het token vernieuwd.
  • authority: URL van de instantie waarvan de toepassing tokens verkrijgt.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • gebruikersnaam - gebruikersnaam van de client
  • wachtwoord - referenties
  • tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token

Enums

LogLevel

Logboekberichtniveau.

Variabelen

AzureCloudInstance
ManagedIdentitySourceNames

Namen van beheerde identiteitsbronnen

ProtocolMode

Protocolmodi die worden ondersteund door MSAL.

ResponseMode

toegestane waarden voor response_mode

AuthErrorMessage

AuthErrorMessage-klasse met tekenreeksconstanten die worden gebruikt door foutcodes en berichten.

ClientAuthErrorMessage

Tekenreeksconstanten die worden gebruikt door foutcodes en berichten.

ClientConfigurationErrorMessage

ClientConfigurationErrorMessage-klasse met tekenreeksconstanten die worden gebruikt door foutcodes en berichten.

InteractionRequiredAuthErrorMessage

Vereiste interactiefouten die zijn gedefinieerd door de SDK

PromptValue

We hebben overwogen deze 'enum' in de aanvraag in plaats van tekenreeks te maken, maar het lijkt erop dat de toegestane lijst met promptwaarden de afgelopen jaren is gewijzigd. Er zijn ook enkele niet-gedocumenteerde promptwaarden voor sommige interne partners, vandaar de keuze van het algemene 'tekenreekstype' in plaats van de 'enum'

version

Variabele details

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" }

Type

{ 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 van beheerde identiteitsbronnen

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

Type

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

ProtocolMode

Protocolmodi die worden ondersteund door MSAL.

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

Type

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

ResponseMode

toegestane waarden voor response_mode

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

Type

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

AuthErrorMessage

Waarschuwing

Deze API is nu afgeschaft.

Use AuthErrorCodes instead

AuthErrorMessage-klasse met tekenreeksconstanten die worden gebruikt door foutcodes en berichten.

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

Type

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

ClientAuthErrorMessage

Waarschuwing

Deze API is nu afgeschaft.

Use ClientAuthErrorCodes instead

Tekenreeksconstanten die worden gebruikt door foutcodes en berichten.

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 } }

Type

{ 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

Waarschuwing

Deze API is nu afgeschaft.

Use ClientConfigurationErrorCodes instead

ClientConfigurationErrorMessage-klasse met tekenreeksconstanten die worden gebruikt door foutcodes en berichten.

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 } }

Type

{ 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

Waarschuwing

Deze API is nu afgeschaft.

Use InteractionRequiredAuthErrorCodes instead

Vereiste interactiefouten die zijn gedefinieerd door de SDK

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 } }

Type

{ 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

We hebben overwogen deze 'enum' in de aanvraag in plaats van tekenreeks te maken, maar het lijkt erop dat de toegestane lijst met promptwaarden de afgelopen jaren is gewijzigd. Er zijn ook enkele niet-gedocumenteerde promptwaarden voor sommige interne partners, vandaar de keuze van het algemene 'tekenreekstype' in plaats van de 'enum'

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

Type

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

version

version: "3.8.10"

Type

"3.8.10"