@azure/msal-common package

Klasser

AuthError

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

AuthenticationHeaderParser

Det här är en hjälpklass som parsar http-svarsautentiseringshuvuden som stöds för att extrahera och returnera huvudutmaningsvärden som kan användas utanför de grundläggande auktoriseringsflödena.

CacheError

Fel uppstod när det uppstod ett fel i cacheminnet

ClientAuthError

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

ClientConfigurationError

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

InteractionRequiredAuthError

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

Logger

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

NetworkError

Representerar nätverksrelaterade fel

PerformanceClient
PlatformBrokerError

Felklass för MSAL Runtime-fel som bevarar detaljerad koordinatorinformation

ProtocolUtils

Klass som tillhandahåller hjälp för OAuth 2.0-protokollspecifika värden

ScopeSet

Klassen ScopeSet skapar en uppsättning omfång. Omfång är skiftlägeskänsliga, unika värden, så det är bäst att implementera set-objektet i JS för den här klassen. Alla omfång trimmas och konverteras till gemener i skärnings- och unionsfunktioner för att säkerställa att strängarna är unika.

ServerError

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

StubPerformanceClient
UrlString

Url-objektklass som kan utföra olika transformeringar på URL-strängar.

TokenCacheContext

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

Gränssnitt

ICrypto

Gränssnitt för kryptofunktioner som används av biblioteket

ILoggerCallback
INetworkModule

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

IPerformanceClient
IPerformanceMeasurement
IUri

Gränssnitt som beskriver URI-komponenter.

PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

Typalias

AccessTokenEntity

Cachetyp för åtkomsttoken

AccountFilter

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

AccountInfo

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
ActiveAccountFilters
AppMetadataEntity

Cachetyp för appmetadata

ApplicationTelemetry

Telemetriinformation som skickas på begäran

  • appName: Unikt strängnamn för ett program
  • appVersion: Version av programmet med MSAL
AuthenticationResult

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
AuthorityOptions
AuthorizationCodePayload

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

AuthorizeResponse

Svarsegenskaper som kan returneras av slutpunkten /authorize

AzureCloudOptions

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
AzureRegion
AzureRegionConfiguration
BaseAuthRequest

BaseAuthRequest

  • authority – URL för utfärdaren, säkerhetstokentjänsten (STS) från vilken MSAL hämtar token. Standardinställningen är https://login.microsoftonline.com/common. Om du använder samma utfärdare för alla begäranden bör utfärdaren ange klientprogramobjektet och inte begära det, för att undvika att lösa utfärdarslutpunkter flera gånger.
  • 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.
  • scopes – Matris med omfång som programmet begär åtkomst till.
  • authenticationScheme – den typ av token som hämtas. Standardvärdet är "Bearer". Kan också vara typ "pop" eller "SSH".
  • anspråk – En begäran om strängifierade anspråk som läggs till i alla /auktorisera och /tokenanrop
  • shrClaims – ett strängifierat anspråksobjekt som läggs till i en signerad HTTP-begäran
  • shrNonce – en servergenererad tidsstämpel som har krypterats och base64URL-kodats, som läggs till i en signerad HTTP-begäran.
  • shrOptions – ett objekt som innehåller alternativ för den signerade HTTP-begäran
  • resourceRequestMethod – HTTP-begärandetyp som används för att begära data från resursen (t.ex. "GET", "POST" osv.). Används för proof-of-possession-flöden.
  • resourceRequestUri – URI som token ska användas för. Används för proof-of-possession-flöden.
  • sshJwk – en strängifierad JSON-webbnyckel som representerar en offentlig nyckel som kan signeras av ett SSH-certifikat.
  • sshKid – nyckel-ID som unikt identifierar den offentliga SSH-nyckel som nämns ovan.
  • azureCloudOptions – Uppräkning av bekvämlighetssträngar för användare för att tillhandahålla offentliga/nationella moln-ID:t
  • requestedClaimsHash – SHA 256-hashsträngen för den begärda anspråkssträngen, som används som en del av en cachenyckel för åtkomsttoken så att token kan filtreras efter begärda anspråk
  • tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
  • tokenBodyParameters – Sträng till strängkarta över anpassade parametrar som lagts till i brödtexten i /token-anropet
  • storeInCache – objekt som innehåller booleska värden som anger om token ska lagras i cacheminnet eller inte (standardvärdet är sant)
  • scenarioId – Scenario-ID för att spåra anpassade användarfrågor
  • popKid – Nyckel-ID för att identifiera den offentliga nyckeln för PoP-tokenbegäran
  • embeddedClientId – Inbäddat klient-ID. När det anges anges koordinatorklient-ID (brk_client_id) och omdirigerings-URI (brk_redirect_uri) params med värden från konfigurationen, vilket åsidosättar motsvarande extra parametrar, om det finns.
  • httpMethod – HTTP-metod som ska användas för /authorize-begäran. Standardvärdet är GET, men kan ställas in på POST om begäran kräver brödtextparametrar
  • authorizePostBodyParameters – Sträng till strängkarta över anpassade parametrar som lagts till i brödtexten i /authorize-anropet när httpMethod är inställt på POST
  • skipBrokerClaims – När sant och ett asynkront flöde används (till exempel när broker-params eller ett embeddedClientId finns), kommer clientCapabilities från konfigurationen att undantas från anspråk; ignoreras för icke-asynkrona flöden.
CacheOptions

Använd detta för att konfigurera cacheinställningar för autentiseringsuppgifter i ClientConfiguration-objektet

  • claimsBasedCachingEnabled – Anger om token ska cachelagras baserat på anspråkshash. Standardvärdet är false.
CcsCredential
ClientInfo

Klientinformationsobjekt som består av: uid: användar-ID utid: klient-ID xms_tdbr: valfritt, endast för icke-amerikanska klientorganisationer

CommonAuthorizationCodeRequest

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
  • 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
  • resourceRequestMethod – HTTP-begärandetyp som används för att begära data från resursen (t.ex. "GET", "POST" osv.). Används för proof-of-possession-flöden.
  • resourceRequestUri – URI som token ska användas för. Används för proof-of-possession-flöden.
  • enableSpaAuthCode – Aktiverar acqusition av en spa-auktoriseringskod (endast konfidentiella klienter)
  • tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
CommonAuthorizationUrlRequest

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 kontoskapandet i stället för inloggningsupplevelsen no_session: läser inte befintlig sessionstoken när användaren autentiseras. När användaren har autentiserats skapar inte EVO någon ny session för användaren. ENDAST FÖR INTERNT BRUK.
  • 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.
  • resourceRequestMethod – HTTP-begärandetyp som används för att begära data från resursen (t.ex. "GET", "POST" osv.). Används för proof-of-possession-flöden.
  • resourceRequestUri – URI som token ska användas för. Används för proof-of-possession-flöden.
CommonEndSessionRequest

CommonEndSessionRequest

  • account – Kontoobjekt som loggas ut från. Alla token som är kopplade till det här kontot rensas.
  • postLogoutRedirectUri – URI att navigera till efter utloggningssidan.
  • 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.
  • idTokenHint – ID-token som används av B2C för att verifiera utloggning om det krävs av principen
  • state – Ett värde som ingår i begäran till utloggningsslutpunkten som returneras i frågesträngen vid omdirigering efter utloggning
  • logoutHint – en sträng som anger det konto som loggas ut för att hoppa över serverkontoväljaren vid utloggning
  • extraQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /authorize-anropet
CommonRefreshTokenRequest

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.
  • resourceRequestMethod – HTTP-begärandetyp som används för att begära data från resursen (t.ex. "GET", "POST" osv.). Används för proof-of-possession-flöden.
  • resourceRequestUri – URI som token ska användas för. Används för proof-of-possession-flöden.
  • 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.
  • tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
CommonSilentFlowRequest

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.
  • account – Kontoentitet för att söka efter autentiseringsuppgifterna.
  • forceRefresh – Tvingar tysta begäranden att göra nätverksanrop om det är sant.
  • resourceRequestMethod – HTTP-begärandetyp som används för att begära data från resursen (t.ex. "GET", "POST" osv.). Används för proof-of-possession-flöden.
  • resourceRequestUri – URI som token ska användas för. Används för proof-of-possession-flöden.
  • tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
CredentialEntity

Cachetyp för autentiseringsuppgifter

CredentialFilter

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

ExternalTokenResponse

Svarsobjekt som används för att läsa in externa token till cacheminnet.

  • token_type: Anger värdet för tokentyp. Den enda typ som Azure AD stöder är Bearer.
  • omfång: De omfång som access_token är giltiga för.
  • expires_in: Hur länge åtkomsttoken är giltig (i sekunder).
  • id_token: En JSON-webbtoken (JWT). Appen kan avkoda segmenten för den här token för att begära information om användaren som loggade in.
  • refresh_token: En OAuth 2.0-uppdateringstoken. Appen kan använda den här token för att hämta ytterligare åtkomsttoken när den aktuella åtkomsttoken upphör att gälla.
  • access_token: Den begärda åtkomsttoken. Appen kan använda den här token för att autentisera till den skyddade resursen, till exempel ett webb-API.
  • client_info: Klientinformationsobjekt
IdTokenEntity

Cachetyp för ID-token

InProgressPerformanceEvent
LibraryStateObject

Typ som definierar objektet som är strängifierat, kodat och skickat i tillståndsvärdet. Innehåller följande:

  • ID – unik identifierare för den här begäran
  • ts – tidsstämpel för den tid då begäran gjordes. Används för att säkerställa att tokens giltighetstid inte beräknas felaktigt.
  • platformState – strängvärde som skickas från plattformen.
LoggerOptions

Använd detta för att konfigurera loggning som MSAL gör genom att konfigurera loggningsalternativ i konfigurationsobjektet

  • loggerCallback – Återanrop för logger
  • piiLoggingEnabled – Anger om pii-loggning är aktiverat
  • logLevel – Anger den nivå där loggning sker
  • correlationId – Anger det correlationId som skrivs ut av loggaren
NetworkRequestOptions

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

NetworkResponse
OIDCOptions

Alternativ för OIDC-protokollläget.

PerformanceCallbackFunction
PerformanceEvent

Prestandamätning som görs av biblioteket, inklusive metadata om begäran och programmet.

PkceCodes

Typen PkceCodes beskriver strukturen för objekt som innehåller PKCE-kodutmaning och verifierarpar

QueueMeasurement

Kömätningstyp

RefreshTokenEntity

Cachetyp för uppdateringstoken

RequestStateObject

Typ som definierar det strängifierade och kodade objektet som skickas till tjänsten i auktoriseringsbegäran.

RequestThumbprint

Typ som representerar ett unikt tumavtryck för begäran.

ServerAuthorizationTokenResponse

Deserialiserat svarsobjekt från begäran om serverauktoriseringskod.

  • token_type: Anger värdet för tokentyp. Kan vara antingen Bearer eller pop.
  • omfång: De omfång som access_token är giltiga för.
  • expires_in: Hur länge åtkomsttoken är giltig (i sekunder).
  • refresh_in: Varaktighetsafer som en token ska förnyas, oavsett förfallodatum.
  • ext_expires_in: Hur länge åtkomsttoken är giltig (i sekunder) om servern inte svarar.
  • access_token: Den begärda åtkomsttoken. Appen kan använda den här token för att autentisera till den skyddade resursen, till exempel ett webb-API.
  • refresh_token: En OAuth 2.0-uppdateringstoken. Appen kan använda den här token för att hämta ytterligare åtkomsttoken när den aktuella åtkomsttoken upphör att gälla.
  • id_token: En JSON-webbtoken (JWT). Appen kan avkoda segmenten för den här token för att begära information om användaren som loggade in.
  • key_id: En sträng som unikt identifierar en offentlig nyckel som begäran är bunden till.

Vid fel:

  • fel: En felkodssträng som kan användas för att klassificera typer av fel som inträffar och som kan användas för att reagera på fel.
  • error_description: Ett specifikt felmeddelande som kan hjälpa en utvecklare att identifiera rotorsaken till ett autentiseringsfel.
  • error_codes: En lista över STS-specifika felkoder som kan hjälpa dig med diagnostik.
  • timestamp: Den tid då felet inträffade.
  • trace_id: En unik identifierare för begäran som kan hjälpa dig med diagnostik.
  • correlation_id: En unik identifierare för begäran som kan hjälpa till med diagnostik mellan komponenter.
  • status: nätverksbegärans svarsstatus
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache

Styr om token ska lagras i cacheminnet eller inte. Om värdet är falskt kan token fortfarande hämtas och returneras, men cachelagras inte för senare hämtning.

StringDict

Key-Value typ för att stödja queryParams, extraQueryParams och anspråk

SubMeasurement
SystemOptions

Använd detta för att konfigurera information om tokenförnyelse i konfigurationsobjektet

  • tokenRenewalOffsetSeconds – Anger det förskjutningsfönster som krävs för att förnya token innan den upphör att gälla
TenantProfile

Kontoinformation som varierar mellan klienter för samma användare

ThrottlingEntity
TokenClaims

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

TokenKeys
AppTokenProviderParameters

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
AppTokenProviderResult

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

Autentiseringsuppgifter för klientkontroll för konfidentiella klienter

ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest

CommonClientCredentialRequest

  • 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.
  • skipCache – Hoppa över uppslag för tokencache och tvinga begäran till utfärdaren att hämta en ny token. Standardvärdet är falskt.
  • preferredAzureRegionOptions – Alternativ för användarens föredragna Azure-region
  • tokenQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i /token-anropet
CommonDeviceCodeRequest

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.
  • resourceRequestMethod – HTTP-begärandetyp som används för att begära data från resursen (t.ex. "GET", "POST" osv.). Används för proof-of-possession-flöden.
  • resourceRequestUri – URI som token ska användas för. Används för proof-of-possession-flöden.
  • timeout – tidsgränsperiod i sekunder som användaren uttryckligen konfigurerar för avsökning av enhetskodslutpunkten. I slutet av denna period; förutsatt att enhetskoden inte har upphört att gälla än. avsökningen av enhetskoden stoppas och begäran avbryts. Förfallofönstret för enhetskoden har alltid företräde under den här angivna perioden.
  • extraQueryParameters – Sträng till strängkarta över anpassade frågeparametrar som lagts till i frågesträngen
CommonOnBehalfOfRequest
  • 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
CommonUsernamePasswordRequest

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

DeviceCode returneras av enhetskodslutpunkten för säkerhetstokentjänsten som innehåller information som krävs för enhetskodflödet.

  • userCode: kod som användaren måste ange vid autentisering vid verifierings-URI:n
  • deviceCode: kod som ska ingå i begäran om åtkomsttoken
  • verificationUri: URI där användaren kan autentisera
  • expiresIn: förfallotid för enhetskoden i sekunder
  • intervall: intervall med vilket STS ska avsökas vid
  • meddelande: meddelande som ska visas för användaren
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

Uppräkningar

LogLevel

Loggmeddelandenivå.

PerformanceEventStatus

Tillstånd för prestandahändelsen.

PerformanceEvents

Uppräkning av åtgärder som instrumenteras av får sina prestanda mätta med PerformanceClient.

Funktioner

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)
buildClientInfo(string, (input: string) => string)

Funktion för att skapa ett klientinformationsobjekt från serverklientInfosträngen

buildClientInfoFromHomeAccountId(string)

Funktion för att skapa ett klientinformationsobjekt från cachelagrad homeAccountId-sträng

buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)

Skapa klientprofil

createAuthError(string, string)
createCacheError(unknown)

Hjälpfunktionen för att omsluta webbläsarfel i ett CacheError-objekt

createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)

Skapar en InteractionRequiredAuthError

createNetworkError(AuthError, number, Record<string, string>, Error)

Skapar NetworkError-objekt för en misslyckad nätverksbegäran

formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)

Hämtar tenantId från tillgängliga ID-tokenanspråk för att ange som autentiseringssfär med följande prioritet:

  1. tid – om token hämtas från en Azure AD-klienttid kommer att finnas
  2. tfp – om token hämtas från en modern B2C-klient-tfp ska finnas
  3. acr – om token hämtas från en äldre B2C-klientacr ska presenteras nedskalade för att matcha kraven på skiftlägeskänslig jämförelse för sfären
tenantIdMatchesHomeTenant(string, string)

Returnerar sant om tenantId matchar utid-delen av homeAccountId

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Ersätter kontoinformation som varierar beroende på klientprofil som hämtas från de ID-tokenanspråk som skickas med den klientspecifika kontoinformationen

Variabler

AADAuthorityConstants

Strängkonstanter relaterade till AAD-utfärdare

AuthenticationScheme

Typ av autentiseringsbegäran

AuthorityType

Auktoritetstyper som stöds av MSAL.

AzureCloudInstance
CacheAccountType

Kontotyper i Cache

CacheOutcome

Anger orsaken till att hämta åtkomsttoken från identitetsprovidern

CacheType

Kombinera alla cachetyper

CcsCredentialType
ClaimsRequestKeys

Begärandenycklar för anspråk

CredentialType

Typ av autentiseringsuppgifter som lagras i cacheminnet

EncodingTypes
GrantType

tillåtna grant_type

HeaderNames

Namn på begärandehuvud

HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType

Tillåtna värden för response_type

PasswordGrantConstants

Parametrar för lösenordsbidrag

PersistentCacheKeys

Beständiga cachenycklar MSAL som finns kvar medan användaren är inloggad.

ProtocolMode

Protokolllägen som stöds av MSAL.

ResponseMode

tillåtna värden för response_mode

ServerResponseType

tillåtna värden för serversvarstyp

AuthErrorMessage

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

ClientAuthErrorMessage

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

ClientConfigurationErrorMessage

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

CodeChallengeMethodValues

tillåtna värden för codeVerifier

Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage

Interaktionsfel som krävs som definieras av SDK

OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue

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"

StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants

Konstanter relaterade till begränsning

version

Funktionsinformation

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)

function buildAccountToCache(cacheStorage: CacheManager, authority: Authority, homeAccountId: string, base64Decode: (input: string) => string, correlationId: string, idTokenClaims?: TokenClaims, clientInfo?: string, environment?: string, claimsTenantId?: null | string, authCodePayload?: AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): AccountEntity

Parametrar

cacheStorage

CacheManager

authority

Authority

homeAccountId

string

base64Decode

(input: string) => string

correlationId

string

idTokenClaims
TokenClaims
clientInfo

string

environment

string

claimsTenantId

null | string

authCodePayload
AuthorizationCodePayload
nativeAccountId

string

logger
Logger

Returer

AccountEntity

buildClientInfo(string, (input: string) => string)

Funktion för att skapa ett klientinformationsobjekt från serverklientInfosträngen

function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo

Parametrar

rawClientInfo

string

base64Decode

(input: string) => string

Returer

buildClientInfoFromHomeAccountId(string)

Funktion för att skapa ett klientinformationsobjekt från cachelagrad homeAccountId-sträng

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Parametrar

homeAccountId

string

Returer

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions

Parametrar

authOptions

Partial<AuthorityOptions>

Returer

buildTenantProfile(string, string, string, TokenClaims)

Skapa klientprofil

function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile

Parametrar

homeAccountId

string

Startkontoidentifierare för det här kontoobjektet

localAccountId

string

Lokal kontoidentifer för det här kontoobjektet

tenantId

string

Fullständigt klient- eller organisations-ID som det här kontot tillhör

idTokenClaims
TokenClaims

Anspråk från ID-token

Returer

createAuthError(string, string)

function createAuthError(code: string, additionalMessage?: string): AuthError

Parametrar

code

string

additionalMessage

string

Returer

createCacheError(unknown)

Hjälpfunktionen för att omsluta webbläsarfel i ett CacheError-objekt

function createCacheError(e: unknown): CacheError

Parametrar

e

unknown

Returer

createClientAuthError(string, string)

function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError

Parametrar

errorCode

string

additionalMessage

string

Returer

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Parametrar

errorCode

string

Returer

createInteractionRequiredAuthError(string)

Skapar en InteractionRequiredAuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Parametrar

errorCode

string

Returer

createNetworkError(AuthError, number, Record<string, string>, Error)

Skapar NetworkError-objekt för en misslyckad nätverksbegäran

function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError

Parametrar

error
AuthError

Fel som ska returneras till anroparen

httpStatus

number

Statuskod för nätverksbegäran

responseHeaders

Record<string, string>

Svarshuvuden för nätverksbegäran, när det är tillgängligt

additionalError

Error

Returer

NetworkError-objekt

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Parametrar

authorityUri

string

Returer

string

getRequestThumbprint(string, BaseAuthRequest, string)

function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint

Parametrar

clientId

string

request
BaseAuthRequest
homeAccountId

string

Returer

getTenantIdFromIdTokenClaims(TokenClaims)

Hämtar tenantId från tillgängliga ID-tokenanspråk för att ange som autentiseringssfär med följande prioritet:

  1. tid – om token hämtas från en Azure AD-klienttid kommer att finnas
  2. tfp – om token hämtas från en modern B2C-klient-tfp ska finnas
  3. acr – om token hämtas från en äldre B2C-klientacr ska presenteras nedskalade för att matcha kraven på skiftlägeskänslig jämförelse för sfären
function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

Parametrar

idTokenClaims
TokenClaims

Returer

string | null

tenantIdMatchesHomeTenant(string, string)

Returnerar sant om tenantId matchar utid-delen av homeAccountId

function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean

Parametrar

tenantId

string

homeAccountId

string

Returer

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Ersätter kontoinformation som varierar beroende på klientprofil som hämtas från de ID-tokenanspråk som skickas med den klientspecifika kontoinformationen

function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo

Parametrar

baseAccountInfo
AccountInfo
tenantProfile
TenantProfile
idTokenClaims
TokenClaims
idTokenSecret

string

Returer

Variabelinformation

AADAuthorityConstants

Strängkonstanter relaterade till AAD-utfärdare

AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

Typ

{ COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

AuthenticationScheme

Typ av autentiseringsbegäran

AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

Typ

{ BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

AuthorityType

Auktoritetstyper som stöds av MSAL.

AuthorityType: { Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

Typ

{ Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

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

CacheAccountType

Kontotyper i Cache

CacheAccountType: { ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

Typ

{ ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

CacheOutcome

Anger orsaken till att hämta åtkomsttoken från identitetsprovidern

CacheOutcome: { CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

Typ

{ CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

CacheType

Kombinera alla cachetyper

CacheType: { ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

Typ

{ ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

CcsCredentialType

CcsCredentialType: { HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

Typ

{ HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

ClaimsRequestKeys

Begärandenycklar för anspråk

ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

Typ

{ ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

CredentialType

Typ av autentiseringsuppgifter som lagras i cacheminnet

CredentialType: { ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

Typ

{ ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

EncodingTypes

EncodingTypes: { BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

Typ

{ BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

GrantType

tillåtna grant_type

GrantType: { AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

Typ

{ AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

HeaderNames

Namn på begärandehuvud

HeaderNames: { AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

Typ

{ AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

HttpMethod

HttpMethod: { GET: "GET", POST: "POST" }

Typ

{ GET: "GET", POST: "POST" }

HttpStatus

HttpStatus: { BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

Typ

{ BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

JsonWebTokenTypes

JsonWebTokenTypes: { Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

Typ

{ Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

OAuthResponseType

Tillåtna värden för response_type

OAuthResponseType: { CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

Typ

{ CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

PasswordGrantConstants

Parametrar för lösenordsbidrag

PasswordGrantConstants: { password: "password", username: "username" }

Typ

{ password: "password", username: "username" }

PersistentCacheKeys

Beständiga cachenycklar MSAL som finns kvar medan användaren är inloggad.

PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

Typ

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

ProtocolMode

Protokolllägen som stöds av MSAL.

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

Typ

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

ResponseMode

tillåtna värden för response_mode

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

Typ

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

ServerResponseType

Varning

Det här API:et är nu inaktuellt.

Use ResponseMode instead

tillåtna värden för serversvarstyp

ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }

Typ

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

AuthErrorMessage

Varning

Det här API:et är nu inaktuellt.

Use AuthErrorCodes instead

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

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

Typ

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

ClientAuthErrorMessage

Varning

Det här API:et är nu inaktuellt.

Use ClientAuthErrorCodes instead

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

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

Varning

Det här API:et är nu inaktuellt.

Use ClientConfigurationErrorCodes instead

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

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

CodeChallengeMethodValues

tillåtna värden för codeVerifier

CodeChallengeMethodValues: { PLAIN: string, S256: string }

Typ

{ PLAIN: string, S256: string }

Constants

Constants: { AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

Typ

{ AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

DEFAULT_CRYPTO_IMPLEMENTATION

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

Typ

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Typ

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

Typ

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

Typ

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

Typ

ReadonlySet<string>

InteractionRequiredAuthErrorMessage

Varning

Det här API:et är nu inaktuellt.

Use InteractionRequiredAuthErrorCodes instead

Interaktionsfel som krävs som definieras av 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 } }

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

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

Typ

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

Typ

86400000

PromptValue

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"

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 }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

Typ

THE_FAMILY_ID

THE_FAMILY_ID: "1"

Typ

"1"

ThrottlingConstants

Konstanter relaterade till begränsning

ThrottlingConstants: { DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

Typ

{ DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

version

version: "15.17.0"

Typ

"15.17.0"