@azure/msal-common package

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

Dit is een helperklasse die ondersteunde HTTP-antwoordverificatieheaders parseert om waarden voor headeruitdagingen te extraheren en te retourneren die buiten de basisautorisatiestromen kunnen worden gebruikt.

Er is een fout opgetreden wanneer er een fout optreedt met de cache

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

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

Er is een fout opgetreden wanneer gebruikersinteractie is vereist.

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

Vertegenwoordigt netwerkgerelateerde fouten

Foutklasse voor MSAL Runtime-fouten die gedetailleerde brokergegevens behouden

Klasse die helpers biedt voor OAuth 2.0-protocolspecifieke waarden

De ScopeSet-klasse maakt een set bereiken. Bereiken zijn niet hoofdlettergevoelig, unieke waarden, dus het object Set in JS is het meest zinvol om te implementeren voor deze klasse. Alle bereiken worden ingekort en geconverteerd naar tekenreeksen met kleine letters in snijpunt- en samenvoegfuncties om de uniekheid van tekenreeksen te garanderen.

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

Url-objectklasse die verschillende transformaties op URL-tekenreeksen kan uitvoeren.

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

Interface voor cryptofuncties die worden gebruikt door bibliotheek

Clientnetwerkinterface voor het verzenden van back-endaanvragen.

Interface die URI-onderdelen beschrijft.

Cachetype toegangstoken

Account: <home_account_id-environment-realm><><*>

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

Cachetype app-metagegevens

Telemetriegegevens die op aanvraag worden verzonden

• appName: unieke tekenreeksnaam van een toepassing
• appVersion: versie van de toepassing met MSAL

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

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

Antwoordeigenschappen die kunnen worden geretourneerd door het /authorize-eindpunt

Specifieke opties voor AzureCloudInstance

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

BaseAuthRequest

• authority- URL van de instantie, de beveiligingstokenservice (STS) van waaruit MSAL tokens zal verkrijgen. Wordt standaard ingesteld op https://login.microsoftonline.com/common. Als u dezelfde instantie gebruikt voor alle aanvragen, moet de instantie worden ingesteld op clienttoepassingsobject en niet aanvragen, om te voorkomen dat instantie-eindpunten meerdere keren worden omgezet.
• correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
• bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
• authenticationScheme : het type token dat is opgehaald. De standaardwaarde is Bearer. Kan ook 'pop' of 'SSH' zijn.
• claims - Een tekenreeksclaimaanvraag die wordt toegevoegd aan alle aanroepen /authorize en /token
• shrClaims - Een tekenreeks-claimobject dat wordt toegevoegd aan een ondertekende HTTP-aanvraag
• shrNonce: een door de server gegenereerde tijdstempel die is versleuteld en base64URL gecodeerd, die wordt toegevoegd aan een ondertekende HTTP-aanvraag.
• shrOptions - Een object met opties voor de ondertekende HTTP-aanvraag
• resourceRequestMethod - HTTP-aanvraagtype dat wordt gebruikt om gegevens op te vragen van de resource (bijvoorbeeld 'GET', 'POST', enzovoort). Wordt gebruikt voor proof-of-possession-stromen.
• resourceRequestUri - URI waarvoor dat token wordt gebruikt. Wordt gebruikt voor proof-of-possession-stromen.
• sshJwk: een tekenreeksified JSON-websleutel die een openbare sleutel vertegenwoordigt die kan worden ondertekend door een SSH-certificaat.
• sshKid : sleutel-id die de hierboven genoemde openbare SSH-sleutel uniek identificeert.
• azureCloudOptions - Gemaksreeksen voor gebruikers om openbare/onafhankelijke cloud-id's te bieden
• requestedClaimsHash - SHA 256-hashtekenreeks van de aangevraagde claimsreeks, gebruikt als onderdeel van een toegangstokencachesleutel, zodat tokens kunnen worden gefilterd op aangevraagde claims
• tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token
• tokenBodyParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste parameters toegevoegd aan de hoofdtekst van de /token-aanroep
• storeInCache - Object met booleaanse waarden die aangeven of tokens in de cache moeten worden opgeslagen of niet (standaard is waar)
• scenarioId - Scenario-id voor het bijhouden van aangepaste gebruikersprompts
• popKid - Sleutel-id om de openbare sleutel voor poP-tokenaanvraag te identificeren
• embeddedClientId - Ingesloten client-id. Indien opgegeven, worden broker-client-id (brk_client_id) en omleidings-URI-parameters (brk_redirect_uri) ingesteld met waarden uit de configuratie, waarbij de bijbehorende extra parameters worden overschreven, indien aanwezig.
• httpMethod - HTTP-methode die moet worden gebruikt voor de aanvraag /authorize. Standaardinstellingen voor GET, maar kunnen worden ingesteld op POST als voor de aanvraag hoofdtekstparameters zijn vereist
• authorizePostBodyParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste parameters toegevoegd aan de hoofdtekst van de /authorize-aanroep wanneer httpMethod is ingesteld op POST
• skipBrokerClaims : wanneer waar en een brokered stroom wordt gebruikt (bijvoorbeeld wanneer brokerparams of een embeddedClientId aanwezig zijn), worden clientCapabilities van de configuratie uitgesloten van claims; genegeerd voor niet-brokered stromen.

Gebruik deze optie om voorkeuren voor de referentiecache te configureren in het ClientConfiguration-object

• claimsBasedCachingEnabled - Hiermee stelt u in of tokens in de cache moeten worden opgeslagen op basis van de claim-hash. De standaardwaarde is vals.

Clientgegevensobject dat bestaat uit: uid: gebruikers-id utid: tenant-id xms_tdbr: optioneel, alleen voor niet-AMERIKAANSE tenants

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
• 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
• resourceRequestMethod - HTTP-aanvraagtype dat wordt gebruikt om gegevens op te vragen van de resource (bijvoorbeeld 'GET', 'POST', enzovoort). Wordt gebruikt voor proof-of-possession-stromen.
• resourceRequestUri - URI waarvoor dat token wordt gebruikt. Wordt gebruikt voor proof-of-possession-stromen.
• enableSpaAuthCode - Hiermee wordt de acqusition van een spa-autorisatiecode (alleen vertrouwelijke clients) ingeschakeld
• tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token

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 no_session: leest geen bestaand sessietoken wanneer de gebruiker wordt geverifieerd. Wanneer de gebruiker is geverifieerd, maakt EVO geen nieuwe sessie voor de gebruiker. ALLEEN VOOR INTERN GEBRUIK.
• 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.
• resourceRequestMethod - HTTP-aanvraagtype dat wordt gebruikt om gegevens op te vragen van de resource (bijvoorbeeld 'GET', 'POST', enzovoort). Wordt gebruikt voor proof-of-possession-stromen.
• resourceRequestUri - URI waarvoor dat token wordt gebruikt. Wordt gebruikt voor proof-of-possession-stromen.

CommonEndSessionRequest

• account - Accountobject dat wordt afgemeld. Alle tokens die aan dit account zijn gekoppeld, worden gewist.
• postLogoutRedirectUri - URI om naar na afmeldingspagina te navigeren.
• correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
• idTokenHint - ID-token gebruikt door B2C om afmelding te valideren indien vereist door het beleid
• status: een waarde die is opgenomen in de aanvraag voor het afmeldingseindpunt dat wordt geretourneerd in de querytekenreeks na het omleiden van afmelding
• logoutHint - Een tekenreeks die het account aangeeft dat wordt afgemeld om de serveraccountkiezer bij afmelding over te slaan
• extraQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /authorize

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.
• resourceRequestMethod - HTTP-aanvraagtype dat wordt gebruikt om gegevens op te vragen van de resource (bijvoorbeeld 'GET', 'POST', enzovoort). Wordt gebruikt voor proof-of-possession-stromen.
• resourceRequestUri - URI waarvoor dat token wordt gebruikt. Wordt gebruikt voor proof-of-possession-stromen.
• 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.
• tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token

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.
• account - Accountentiteit om de referenties op te zoeken.
• forceRefresh : dwingt stille aanvragen af om netwerkaanroepen uit te voeren, indien waar.
• resourceRequestMethod - HTTP-aanvraagtype dat wordt gebruikt om gegevens op te vragen van de resource (bijvoorbeeld 'GET', 'POST', enzovoort). Wordt gebruikt voor proof-of-possession-stromen.
• resourceRequestUri - URI waarvoor dat token wordt gebruikt. Wordt gebruikt voor proof-of-possession-stromen.
• tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token

Type referentiecache

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

Antwoordobject dat wordt gebruikt voor het laden van externe tokens in de cache.

• token_type: geeft de waarde van het tokentype aan. Het enige type dat Azure AD ondersteunt, is Bearer.
• scope: De bereiken waarvoor de access_token geldig is.
• expires_in: hoe lang het toegangstoken geldig is (in seconden).
• id_token: een JSON-webtoken (JWT). De app kan de segmenten van dit token decoderen om informatie op te vragen over de gebruiker die zich heeft aangemeld.
• refresh_token: een OAuth 2.0-vernieuwingstoken. De app kan dit token gebruiken om extra toegangstokens te verkrijgen nadat het huidige toegangstoken is verlopen.
• access_token: het aangevraagde toegangstoken. De app kan dit token gebruiken om te verifiëren bij de beveiligde resource, zoals een web-API.
• client_info: Clientgegevensobject

Cachetype id-token

Type dat het object definieert dat is gecodeerd, gecodeerd en verzonden in de statuswaarde. Bevat het volgende:

• id - unieke id voor deze aanvraag
• ts - tijdstempel voor het tijdstip waarop de aanvraag is gedaan. Wordt gebruikt om ervoor te zorgen dat het verlopen van tokens niet onjuist wordt berekend.
• platformState: tekenreekswaarde die is verzonden vanaf het platform.

Gebruik dit om de logboekregistratie te configureren die MSAL doet door logboekregistratieopties in het configuratieobject te configureren

• loggerCallback - Callback voor logger
• piiLoggingEnabled - Hiermee stelt u in of pii-logboekregistratie is ingeschakeld
• logLevel - Stelt het niveau in waarop logboekregistratie plaatsvindt
• correlationId - Hiermee stelt u de correlationId in die door de logger wordt afgedrukt

Opties die zijn toegestaan door API's voor netwerkaanvragen.

Opties voor de OIDC-protocolmodus.

Prestatiemeting uitgevoerd door de bibliotheek, inclusief metagegevens over de aanvraag en toepassing.

Het type PkceCodes beschrijft de structuur van objecten die pkCE-codevraag- en verifierparen bevatten

Type wachtrijmeting

Cachetype token vernieuwen

Type dat het tekenreeksen en gecodeerde object definieert dat in de autorisatieaanvraag naar de service is verzonden.

Typ een unieke aanvraagvingerafdruk.

Ontserialized antwoordobject van aanvraag voor serverautorisatiecode.

• token_type: geeft de waarde van het tokentype aan. Kan Bearer of pop zijn.
• scope: De bereiken waarvoor de access_token geldig is.
• expires_in: hoe lang het toegangstoken geldig is (in seconden).
• refresh_in: Duur die aangeeft welke token moet worden vernieuwd, ongeacht de vervaldatum.
• ext_expires_in: hoe lang het toegangstoken geldig is (in seconden) als de server niet reageert.
• access_token: het aangevraagde toegangstoken. De app kan dit token gebruiken om te verifiëren bij de beveiligde resource, zoals een web-API.
• refresh_token: een OAuth 2.0-vernieuwingstoken. De app kan dit token gebruiken om extra toegangstokens te verkrijgen nadat het huidige toegangstoken is verlopen.
• id_token: een JSON-webtoken (JWT). De app kan de segmenten van dit token decoderen om informatie op te vragen over de gebruiker die zich heeft aangemeld.
• key_id: Een tekenreeks waarmee een openbare sleutel wordt geïdentificeerd waaraan de aanvraag is gebonden.

In het geval van een fout:

• fout: Een tekenreeks met foutcodes die kunnen worden gebruikt om typen fouten te classificeren die optreden en kunnen worden gebruikt om te reageren op fouten.
• error_description: een specifiek foutbericht waarmee een ontwikkelaar de hoofdoorzaak van een verificatiefout kan identificeren.
• error_codes: een lijst met STS-specifieke foutcodes die kunnen helpen bij diagnostische gegevens.
• tijdstempel: het tijdstip waarop de fout is opgetreden.
• trace_id: een unieke id voor de aanvraag die kan helpen bij diagnostische gegevens.
• correlation_id: een unieke id voor de aanvraag die kan helpen bij diagnostische gegevens over onderdelen.
• status: de antwoordstatus van de netwerkaanvraag

Hiermee bepaalt u of tokens in de cache moeten worden opgeslagen of niet. Als deze optie is ingesteld op false, kunnen tokens nog steeds worden verkregen en geretourneerd, maar worden ze niet in de cache opgeslagen voor later ophalen.

Key-Value type ter ondersteuning van queryParams, extraQueryParams en claims

Gebruik deze optie om gegevens over het vernieuwen van tokens in het configuratieobject te configureren

• tokenRenewalOffsetSeconds - Hiermee stelt u het offsetvenster in dat nodig is om het token te vernieuwen vóór de vervaldatum

Accountgegevens die per tenant verschillen voor dezelfde gebruiker

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

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

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.

Client-assertiereferenties voor vertrouwelijke clients

CommonClientCredentialRequest

• 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.
• skipCache- Sla het opzoeken van tokencache over en forceer aanvragen om een nieuw token op te halen. Standaard ingesteld op onwaar.
• preferredAzureRegionOptions - Opties van de voorkeursregio van de gebruiker
• tokenQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de aanroep /token

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.
• resourceRequestMethod - HTTP-aanvraagtype dat wordt gebruikt om gegevens op te vragen van de resource (bijvoorbeeld 'GET', 'POST', enzovoort). Wordt gebruikt voor proof-of-possession-stromen.
• resourceRequestUri - URI waarvoor dat token wordt gebruikt. Wordt gebruikt voor proof-of-possession-stromen.
• time-out: time-outperiode in seconden die de gebruiker expliciet configureert voor de polling van het eindpunt van de apparaatcode. Aan het einde van deze periode; ervan uitgaande dat de apparaatcode nog niet is verlopen; de polling van apparaatcode is gestopt en de aanvraag is geannuleerd. Het verloopvenster van de apparaatcode heeft altijd voorrang op deze ingestelde periode.
• extraQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de querytekenreeks

• 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

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

DeviceCode die wordt geretourneerd door het eindpunt van de apparaatcode van de beveiligingstokenservice met informatie die nodig is voor de apparaatcodestroom.

• userCode: code die de gebruiker moet opgeven bij het verifiëren bij de verificatie-URI
• deviceCode: code die moet worden opgenomen in de aanvraag voor het toegangstoken
• verificationUri: URI waar de gebruiker zich kan verifiëren
• expiresIn: verlooptijd van de apparaatcode in seconden
• interval: interval waarop de STS moet worden gepolerd op
• bericht: bericht dat moet worden weergegeven aan de gebruiker

Logboekberichtniveau.

Status van de prestatie-gebeurtenis.

Opsomming van bewerkingen die worden geïnstrueerd door hun prestaties te laten meten door de PerformanceClient.

Functie voor het bouwen van een clientgegevensobject op basis van de clientInfo-tekenreeks van de server

Functie voor het bouwen van een clientgegevensobject op basis van de homeAccountId-tekenreeks in de cache

Tenantprofiel bouwen

Helper-functie voor het verpakken van browserfouten in een CacheError-object

Hiermee maakt u een InteractionRequiredAuthError

Hiermee maakt u networkError-object voor een mislukte netwerkaanvraag

Hiermee haalt u tenantId op van de beschikbare id-tokenclaims die moeten worden ingesteld als referentierealm met de volgende prioriteit:

1. tid - als het token wordt verkregen van een Azure AD-tenant tid aanwezig is
2. tfp: als het token wordt verkregen van een moderne B2C-tenant tfp aanwezig moet zijn
3. acr : als het token wordt verkregen van een verouderde B2C-tenant moet acr downcased zijn om te voldoen aan de vereisten voor het niet-hoofdlettergevoelig vergelijken van de realm

Retourneert waar als tenantId overeenkomt met het utid-gedeelte van homeAccountId

Vervangt accountgegevens die variëren per tenantprofiel dat afkomstig is van de id-tokenclaims die zijn doorgegeven door de tenantspecifieke accountgegevens

Tekenreeksconstanten met betrekking tot AAD-instantie

Type verificatieaanvraag

Autoriteitstypen die worden ondersteund door MSAL.

Accounttypen in cache

Hiermee geeft u de reden voor het ophalen van het toegangstoken van de id-provider

Alle cachetypen combineren

Claimaanvraagsleutels

Referentietype dat is opgeslagen in de cache

toegestane grant_type

Namen van aanvraagheaders

Toegestane waarden voor response_type

Parameters voor wachtwoordtoe kennen

Permanente cachesleutels MSAL die blijven terwijl de gebruiker is aangemeld.

Protocolmodi die worden ondersteund door MSAL.

toegestane waarden voor response_mode

toegestane waarden voor het reactietype van de server

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

Tekenreeksconstanten die worden gebruikt door foutcodes en berichten.

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

toegestane waarden voor codeVerifier

Vereiste interactiefouten die zijn gedefinieerd door de SDK

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'

Constanten met betrekking tot beperking