@azure/msal-node package

Allmän felklass som genereras av biblioteket MSAL.js.

Grundläggande abstrakt klass för alla ClientApplications – offentlig och konfidentiell

Klientkontroll av typen jwt-bearer som används i konfidentiella klientflöden

Ett fel uppstod när ett fel uppstod i klientkoden som körs i webbläsaren.

Ett fel uppstod när det uppstod ett fel i konfigurationen av MSAL.js-biblioteket.

Bevilja OAuth2.0-klientautentiseringsuppgifter

Den här klassen ska användas för att hämta token för konfidentiella klientprogram (webApp, webAPI). Konfidentiella klientprogram konfigurerar programhemligheter, klientcertifikat/intyg efter behov

Den här klassen implementerar MSAL-nodens kryptogränssnitt, vilket gör att den kan utföra base64-kodning och avkodning, generera kryptografiskt slumpmässiga GUID:er och implementera proof key for Code Exchange specs for the OAuth Authorization Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636).

OAuth2.0 Enhetskodklient

Cache-plugin-program som serialiserar data till cacheminnet och deserialiserar data från cacheminnet

Fel uppstod när användarinteraktion krävs.

Klass som underlättar loggning av meddelanden till en viss plats.

Klass för att initiera en hanterad identitet och identifiera tjänsten

DenBehalf-Of klienten

Den här klassen ska användas för att hämta token för offentliga klientprogram (skrivbord, mobil). Offentliga klientprogram är inte betrodda för att lagra programhemligheter på ett säkert sätt och kan därför bara begära token i en användares namn.

Ett fel uppstod när det uppstod ett fel med serverkoden, till exempel otillgänglighet.

Cachehanteraren för minnesintern token

Den här klassinstansen hjälper till att spåra minnesändringar som underlättar beslut att läsa från och skriva till den beständiga cachen

Oauth2.0 Lösenords bevilja klient Obs! Vi stöder endast offentliga klienter för lösenordsbidrag och för rent teständamål

Gränssnitt för cachen som definierar en getter och setter

Gränssnitt för klassen ConfidentialClientApplication som definierar de offentliga API-signaturerna

Gränssnitt för LoopbackClient som gör det möjligt att ersätta standard-loopback-servern med en anpassad implementering.

Klientnätverksgränssnitt för att skicka serverdelsbegäranden.

Gränssnitt som definierar get-metoder för att hämta nycklar som används till identitetsdata i cacheminnet

Gränssnitt för klassen PublicClientApplication som definierar de offentliga API-signaturerna

Tokencachegränssnitt för klienten, vilket ger åtkomst till cache-API:er

Kontoobjekt med följande signatur:

• homeAccountId – Startkontoidentifierare för det här kontoobjektet
• environment – entitet som utfärdade token som representeras av utfärdarens domän (t.ex. login.microsoftonline.com)
• tenantId – Fullständigt klient- eller organisations-ID som det här kontot tillhör
• username – preferred_username anspråk på id_token som representerar det här kontot
• localAccountId – Lokal, klientspecifik kontoidentifer för det här kontoobjektet, som vanligtvis används i äldre fall
• name – Fullständigt namn för kontot, inklusive förnamn och efternamn
• idToken – rå-ID-token
• idTokenClaims – objektet innehåller anspråk från ID-token
• nativeAccountId – användarens interna konto-ID
• tenantProfiles – Karta över klientprofilobjekt för varje klientorganisation som kontot har autentiserats med i webbläsaren
• dataBoundary – Datagräns som extraherats från clientInfo

Indataobjekt för IAppTokenProvider extensiblity. MSAL skapar det här objektet, som kan användas för att skapa en AppTokenProviderResult.

• correlationId – korrelations-ID:t som är associerat med begäran
• tenantId – klient-ID som token måste anges för
• scopes – de omfång som token måste anges för
• anspråk – eventuella extra anspråk som token måste uppfylla

Utdataobjekt för IAppTokenProvider extensiblity.

• accessToken – den faktiska åtkomsttoken, vanligtvis i JWT-format, som uppfyller apptokenProviderParameters för begärandedata
• expiresInSeconds – hur länge token har innan de upphör att gälla, i sekunder. Liknar fältet "expires_in" i ett AAD-tokensvar.
• refreshInSeconds – hur lång tid token har innan den ska uppdateras proaktivt. Liknar fältet "refresh_in" i ett AAD-tokensvar.

Resultat som returneras från utfärdarens tokenslutpunkt.

• uniqueId – oid eller sub anspråk från ID-token
• tenantId – tid anspråk från ID-token
• scopes – Omfång som verifieras för respektive token
• account – En kontoobjektrepresentation av den inloggade användaren
• idToken – Id-token som tagits emot som en del av svaret
• idTokenClaims – MSAL-relevanta ID-tokenanspråk
• accessToken – Åtkomsttoken eller SSH-certifikat som tagits emot som en del av svaret
• fromCache – boolesk som anger om token kom från cacheminnet
• expiresOn – Javascript Date-objekt som representerar relativ förfallotid för åtkomsttoken
• extExpiresOn – Javascript Date-objekt som representerar utökad relativ förfallotid för åtkomsttoken vid serverfel
• refreshOn – Javascript Date-objekt som representerar relativ tid tills en åtkomsttoken måste uppdateras
• state – Värde som skickas av användaren i begäran
• familyId – Familje-ID-identifierare, som vanligtvis endast används för uppdateringstoken
• requestId – begärande-ID som returneras som en del av svaret

Svaret returnerades efter bearbetning av frågesträngen eller fragmentet för kodsvaret.

Begär objekt som skickas av användaren för att hämta en token från servern som utbyter en giltig auktoriseringskod (andra delen av OAuth2.0 Authorization Code-flödet)

• scopes – Matris med omfång som programmet begär åtkomst till.
• anspråk – En begäran om strängifierade anspråk som läggs till i alla /auktorisera och /tokenanrop
• authority: – URL för utfärdaren, säkerhetstokentjänsten (STS) från vilken MSAL hämtar token. Om utfärdaren har angetts för klientprogramobjektet åsidosätter detta värde. Om värdet överskrids sker verifieringen av utfärdaren varje gång. Om samma utfärdare ska användas för alla begäranden anger du på programobjektet i stället för begäranden.
• correlationId – Unik GUID-uppsättning per begäran för att spåra en begäran från slutpunkt till slutpunkt för telemetriändamål.
• redirectUri – omdirigerings-URI:n för din app, där utfärdaren omdirigeras till efter att användaren har angett autentiseringsuppgifter och medgivanden. Den måste exakt matcha en av de omdirigerings-URI:er som du registrerade i portalen.
• tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
• code – den authorization_code som användaren skaffade i den första delen av flödet.
• codeVerifier – samma code_verifier som användes för att hämta authorization_code. Krävs om PKCE användes i begäran om beviljande av auktoriseringskod. Mer information finns i PKCE RFC: https://tools.ietf.org/html/rfc7636
• state – Unikt GUID som genereras av användaren som cachelagras av användaren och skickas till servern under den första delen av flödet. Den här strängen skickas tillbaka av servern med auktoriseringskoden. Användarens cachelagrade tillstånd jämförs sedan med det tillstånd som tas emot från servern för att minska risken för CSRF-attacker. Se även https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.

Begär objekt som skickas av användaren för att hämta en kod från servern (första delen av auktoriseringskodens beviljandeflöde)

• scopes – Matris med omfång som programmet begär åtkomst till.
• anspråk – En begäran om strängifierade anspråk som läggs till i alla /auktorisera och /tokenanrop
• authority – URL för den utfärdare som programmet hämtar token från.
• correlationId – Unik GUID-uppsättning per begäran för att spåra en begäran från slutpunkt till slutpunkt för telemetriändamål.
• redirectUri – omdirigerings-URI där autentiseringssvar kan tas emot av ditt program. Den måste exakt matcha en av de omdirigerings-URI:er som registrerats i Azure portalen.
• extraScopesToConsent – Omfång för en annan resurs när användaren behöver medgivande i förväg.
• responseMode – Anger vilken metod som ska användas för att skicka autentiseringsresultatet till din app. Kan vara fråga, form_post eller fragment. Om inget värde skickas in frågar det som standard.
• codeChallenge – Används för att skydda auktoriseringskod som beviljas via nyckelbevis för code Exchange (PKCE). Mer information finns i PKCE RCF:https://tools.ietf.org/html/rfc7636
• codeChallengeMethod – den metod som används för att koda kodverifieraren för kodutmaningsparametern. Kan vara "oformaterad" eller "S256". Om den undantas antas koduppgiften vara klartext. Mer information finns i PKCE RCF: https://tools.ietf.org/html/rfc7636
• state – Ett värde som ingår i begäran som också returneras i tokensvaret. Ett slumpmässigt genererat unikt värde används vanligtvis för att förhindra förfalskningsattacker mellan webbplatser. Tillståndet används också för att koda information om användarens tillstånd i appen innan autentiseringsbegäran inträffade.
• prompt – Anger vilken typ av användarinteraktion som krävs. inloggning: tvingar användaren att ange sina autentiseringsuppgifter för den begäran och negerar enkel inloggning utan: ser till att användaren inte visas med någon interaktiv fråga. Om begäran inte kan slutföras via enkel inloggning returnerar slutpunkten ett interaction_required medgivande: utlöser dialogrutan OAuth-medgivande efter att användaren har loggat in och ber användaren att bevilja behörigheter till appen select_account: avbryter enkel inloggning-=om du tillhandahåller en kontovalsupplevelse som visar alla konton i sessionen eller eventuella ihågkomna konton eller ett alternativ för att välja att använda ett annat kontoskapande: dirigerar användaren till funktionen för att skapa kontot i stället för inloggningsupplevelsen
• account – AccountInfo hämtas från ett getAccount-API. Kommer att användas i vissa scenarier för att generera login_hint om både loginHint och sid params inte tillhandahålls.
• loginHint – Kan användas för att fylla i fältet användarnamn/e-postadress på inloggningssidan för användaren, om du känner till användarnamnet/e-postadressen i förväg. Ofta använder appar den här parametern vid omautentisering, efter att redan ha extraherat användarnamnet från en tidigare inloggning med hjälp av preferred_username anspråk.
• sid – Sessions-ID, unik identifierare för sessionen. Tillgängligt som ett valfritt anspråk på ID-token.
• domainHint – Ger en ledtråd om klientorganisationen eller domänen som användaren ska använda för att logga in. Värdet för domäntipset är en registrerad domän för klientorganisationen.
• extraQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /authorize-anropet
• tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
• nonce – ett värde som ingår i begäran som returneras i ID-token. Ett slumpmässigt genererat unikt värde används vanligtvis för att minimera reprisattacker.

Svarsegenskaper som kan returneras av slutpunkten /authorize

Specifika alternativ för AzureCloudInstance

• azureCloudInstance – stränguppräkning som ger kort notation för sovaign och offentliga molnmyndigheter
• klientorganisation – etablera för att tillhandahålla klientinformation

Använd detta för att konfigurera asynkrona alternativ för asynkrona meddelandeköer:

• nativeBrokerPlugin – intern broker-implementering (ska importeras från msal-node-extensions)

Obs! De här alternativen är endast tillgängliga för PublicClientApplications med hjälp av auktoriseringskodflödet

Nyckelvärdearkiv för minnesintern cache

Använd detta för att konfigurera konfigurationsalternativen för cachen nedan:

• cachePlugin – Plugin-program för att läsa och skriva tokencache till disk.

CommonClientCredentialRequest

• scopes – Matris med omfång som programmet begär åtkomst till. Innehåller vanligtvis bara .default-omfånget för en enskild resurs. Se: https://dotnet.territoriali.olinfo.it/azure/active-directory/develop/scopes-oidc#the-default-scope
• authority – URL för utfärdaren, säkerhetstokentjänsten (STS) från vilken MSAL hämtar token.
• correlationId – Unik GUID-uppsättning per begäran för att spåra en begäran från slutpunkt till slutpunkt för telemetriändamål.
• skipCache – Hoppa över uppslag för tokencache och tvinga begäran till utfärdaren att hämta en ny token. Standardvärdet är falskt.
• clientAssertion – En kontrollsträng eller en återanropsfunktion som returnerar en kontrollsträng (båda är Base64Url-kodade signerade JWT:er) som används i flödet för klientautentiseringsuppgifter
• tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet

Använd konfigurationsobjektet för att konfigurera MSAL och initiera klientprogramobjektet

• auth: det är här du konfigurerar autentiseringselement som clientID, utfärdare som används för autentisering mot Microsoft Identity Platform
• broker: det är här du konfigurerar asynkrona alternativ
• cache: det är här du konfigurerar cacheplatsen
• system: det är här du kan konfigurera nätverksklienten, loggaren
• telemetri: här kan du konfigurera telemetrialternativ

Parametrar för Oauth2-enhetskodflöde.

• scopes – Matris med omfång som programmet begär åtkomst till.
• authority: – URL för utfärdaren, säkerhetstokentjänsten (STS) från vilken MSAL hämtar token. Om utfärdaren har angetts för klientprogramobjektet åsidosätter detta värde. Om värdet överskrids sker verifieringen av utfärdaren varje gång. Om samma utfärdare ska användas för alla begäranden anger du på programobjektet i stället för begäranden.
• correlationId – Unik GUID-uppsättning per begäran för att spåra en begäran från slutpunkt till slutpunkt för telemetriändamål.
• deviceCodeCallback – Återanrop som innehåller enhetskodsvar. Meddelandet ska visas för slutanvändaren. Slutanvändaren kan sedan navigera till verification_uri, ange user_code och ange autentiseringsuppgifter.
• cancel – Booleskt värde för att avbryta avsökningen av enhetskodslutpunkten. Medan användaren autentiserar på en separat enhet, avsöker MSAL tokenslutpunkten för säkerhetstokentjänsten för intervallet som anges i enhetskodsvaret (vanligtvis 15 minuter). Om du vill stoppa avsökningen och avbryta begäran anger du cancel=true.
• extraQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i frågesträngen

Typ som beskriver ID-tokenanspråk som är kända av MSAL.

Tillfällig typ för att hantera minnesinterna dataobjekt med definierade typer

Begär objekt som skickas av användaren för att konfigurera acquireTokenInteractive API

• openBrowser – Funktion för att öppna en webbläsarinstans i användarens system.
• scopes – Matris med omfång som programmet begär åtkomst till.
• successTemplate: – Mall som ska visas på den öppnade webbläsarinstansen vid lyckat tokenförvärv.
• errorTemplate – Mall som ska visas på den öppnade webbläsarinstansen vid tokenförvärvsfel.
• windowHandle – Används i interna broker-flöden för att korrekt överordna det interna broker-fönstret
• loopbackClient – Anpassad implementering för en loopback-server för att lyssna efter auktoriseringskodsvar.

Cacheformat som lästs från cachebloben som tillhandahålls till konfigurationen under app-instansieringen

ManagedIdentityRequest

• anspråk – en begäran om strängifierade anspråk som ska användas för att avgöra om cacheminnet ska hoppas över eller inte
• forceRefresh – tvingar hanterade identitetsbegäranden att hoppa över cacheminnet och göra nätverksanrop om det är sant
• resource – resurs som begärts för att få åtkomst till det skyddade API:et. Det bör vara av formatet "ResourceIdUri" eller "ResourceIdUri/.default". Till exempelhttps://management.azure.net, eller för Microsoft Graph,https://graph.microsoft.com/.default

Alternativ som tillåts av API:er för nätverksbegäran.

• clientId – klient-ID för programmet.
• authority – url till utfärdaren. Om inget värde har angetts är standardvärdet https://login.microsoftonline.com/common.
• knownAuthorities – behövs för Azure B2C och ADFS. Alla myndigheter som ska användas i klientprogrammet. Endast utfärdarens värd ska skickas in.
• clientSecret – Hemlig sträng som programmet använder när du begär en token. Används endast i konfidentiella klientprogram. Kan skapas i Azure appregistreringsportalen.
• clientAssertion – ett ClientAssertion-objekt som innehåller en kontrollsträng eller en motringningsfunktion som returnerar en kontrollsträng som programmet använder när en token begärs, samt försäkrans typ (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Används endast i konfidentiella klientprogram.
• clientCertificate – certifikat som programmet använder när du begär en token. Används endast i konfidentiella klientprogram. Kräver hexkodat X.509 SHA-1- eller SHA-256-tumavtryck för certifikatet och den PEM-kodade privata nyckeln (strängen ska innehålla -----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY----- )
• protocolMode – Uppräkning som representerar det protokoll som msal följer. Används för att konfigurera rätt slutpunkter.
• skipAuthorityMetadataCache – En flagga för att välja om du vill använda eller inte använda den lokala metadatacachen under initieringen av utfärdaren. Standardvärdet är falskt.
• encodeExtraQueryParams – en flagga för att välja om du vill koda extra frågeparametrar i begärande-URL:en. Standardvärdet är falskt.

Skriv för att konfigurera loggnings- och http-klientalternativ

• logger – Används för att initiera Logger-objektet; TODO: Expandera information om loggare eller länka till dokumentationen om inloggade
• networkClient – Http-klienten används för alla http get- och post-anrop. Standardinställningen är att använda MSAL:s http-standardklient.

• scopes – Matris med omfång som programmet begär åtkomst till.
• authority – URL för utfärdaren, säkerhetstokentjänsten (STS) från vilken MSAL hämtar token.
• correlationId – Unik GUID-uppsättning per begäran för att spåra en begäran från slutpunkt till slutpunkt för telemetriändamål.
• oboAssertion – åtkomsttoken som skickades till API:et på mellannivå. Den här token måste ha en målgrupp för appen som gör den här OBO-begäran.
• skipCache – Hoppa över tokencachesökning och tvinga begäran till utfärdaren att hämta en ny token. Standardvärdet är falskt.
• tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet

CommonRefreshTokenRequest

• scopes – Matris med omfång som programmet begär åtkomst till.
• anspråk – En begäran om strängifierade anspråk som läggs till i alla /auktorisera och /tokenanrop
• authority – URL för utfärdaren, säkerhetstokentjänsten (STS) från vilken MSAL hämtar token.
• correlationId – Unik GUID-uppsättning per begäran för att spåra en begäran från slutpunkt till slutpunkt för telemetriändamål.
• refreshToken – en uppdateringstoken som returnerades från en tidigare begäran till identitetsprovidern.
• tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
• forceCache – Tvinga MSAL att cachelagrat ett flödessvar för uppdateringstoken när det inte finns något konto i cacheminnet. Används för migreringsscenarier.

Typ av autentiseringsuppgifter för åtkomsttoken

Kontotyp

AppMetadata-typ

Typ av Idtoken-autentiseringsuppgifter

Uppdateringstokens autentiseringstyp

SilentFlow-parametrar som skickas av användaren för att hämta autentiseringsuppgifter tyst

• scopes – Matris med omfång som programmet begär åtkomst till.
• claims – en begäran om strängifierade anspråk som läggs till i alla /auktorisera och /tokenanrop. När den ingår i en tyst begäran hoppas cachesökningen över och token uppdateras.
• authority – URL för den utfärdare som programmet hämtar token från.
• correlationId – Unik GUID-uppsättning per begäran för att spåra en begäran från slutpunkt till slutpunkt för telemetriändamål.
• tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
• account – Kontoentitet för att söka efter autentiseringsuppgifterna.
• forceRefresh – Tvingar tysta begäranden att göra nätverksanrop om det är sant.

UsernamePassword-parametrar som skickas av användaren för att hämta autentiseringsuppgifter Obs! Den senaste OAuth 2.0 Security Best Current Practice tillåter inte att lösenordet beviljas helt. Det här flödet läggs till för intern testning.

• scopes – Matris med omfång som programmet begär åtkomst till.
• claims – en begäran om strängifierade anspråk som läggs till i alla /auktorisera och /tokenanrop. När den ingår i en tyst begäran hoppas cachesökningen över och token uppdateras.
• authority – URL för den utfärdare som programmet hämtar token från.
• correlationId – Unik GUID-uppsättning per begäran för att spåra en begäran från slutpunkt till slutpunkt för telemetriändamål.
• username – användarnamn för klienten
• lösenord – autentiseringsuppgifter
• tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet

Loggmeddelandenivå.

Källnamn för hanterad identitet

Protokolllägen som stöds av MSAL.

tillåtna värden för response_mode

Klassen AuthErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden.

Strängkonstanter som används av felkoder och meddelanden.

Klassen ClientConfigurationErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden.

Interaktionsfel som krävs som definieras av SDK

Vi övervägde att göra den här "uppräkningen" i begäran i stället för strängen, men det ser ut som den tillåtna listan med promptvärden som har ändrats under de senaste åren. Det finns vissa odokumenterade promptvärden för vissa interna partner också, därav valet av generisk "sträng"-typ i stället för "uppräkning"