@azure/msal-common package

Classi

AuthError

Classe di errore generale generata dalla libreria di MSAL.js.

AuthenticationHeaderParser

Si tratta di una classe helper che analizza le intestazioni di autenticazione della risposta HTTP supportate per estrarre e restituire i valori di richiesta di intestazione che possono essere usati all'esterno dei flussi di autorizzazione di base.

CacheError

Errore generato quando si verifica un errore con la cache

ClientAuthError

Errore generato quando si verifica un errore nel codice client in esecuzione nel browser.

ClientConfigurationError

Errore generato quando si verifica un errore nella configurazione della libreria di MSAL.js.

InteractionRequiredAuthError

Errore generato quando è necessaria l'interazione dell'utente.

Logger

Classe che facilita la registrazione dei messaggi in una posizione specifica.

NetworkError

Rappresenta gli errori correlati alla rete

PerformanceClient
PlatformBrokerError

Classe di errore per gli errori del runtime MSAL che mantiene informazioni dettagliate sul broker

ProtocolUtils

Classe che fornisce helper per valori specifici del protocollo OAuth 2.0

ScopeSet

La classe ScopeSet crea un set di ambiti. Gli ambiti non fanno distinzione tra maiuscole e minuscole, valori univoci, quindi l'oggetto Set in JS ha il senso più appropriato da implementare per questa classe. Tutti gli ambiti vengono tagliati e convertiti in stringhe minuscole nelle funzioni di intersezione e unione per garantire l'univocità delle stringhe.

ServerError

Errore generato quando si verifica un errore con il codice del server, ad esempio l'indisponibilità.

StubPerformanceClient
UrlString

Classe di oggetti URL che può eseguire varie trasformazioni sulle stringhe URL.

TokenCacheContext

Questa istanza di classe consente di tenere traccia delle modifiche alla memoria semplificando le decisioni di lettura e scrittura nella cache persistente

Interfacce

ICrypto

Interfaccia per le funzioni di crittografia usate dalla libreria

ILoggerCallback
INetworkModule

Interfaccia di rete client per inviare richieste back-end.

IPerformanceClient
IPerformanceMeasurement
IUri

Interfaccia che descrive i componenti URI.

PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

Alias tipo

AccessTokenEntity

Tipo di cache del token di accesso

AccountFilter

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

AccountInfo

Oggetto Account con la firma seguente:

  • homeAccountId - Identificatore dell'account home per questo oggetto account
  • environment - Entità che ha emesso il token rappresentato dal dominio dell'autorità emittente (ad esempio, login.microsoftonline.com)
  • tenantId: tenant completo o ID organizzazione a cui appartiene l'account
  • username : preferred_username attestazione del id_token che rappresenta questo account
  • localAccountId - Identificatore di account locale e specifico del tenant per questo oggetto account, in genere usato nei casi legacy
  • name - Nome completo per l'account, inclusi il nome e il nome della famiglia specificati
  • idToken - token ID non elaborato
  • idTokenClaims - L'oggetto contiene attestazioni dal token ID
  • nativeAccountId - ID dell'account nativo dell'utente
  • tenantProfiles : mappa degli oggetti profilo tenant per ogni tenant con cui l'account è stato autenticato nel browser
  • dataBoundary - Limite dati estratto da clientInfo
ActiveAccountFilters
AppMetadataEntity

Tipo di cache dei metadati dell'app

ApplicationTelemetry

Informazioni di telemetria inviate su richiesta

  • appName: nome stringa univoco di un'applicazione
  • appVersion: versione dell'applicazione con MSAL
AuthenticationResult

Risultato restituito dall'endpoint del token dell'autorità.

  • uniqueId - oid o sub attestazione dal token ID
  • tenantId : tid attestazione dal token ID
  • ambiti: ambiti convalidati per il rispettivo token
  • account: rappresentazione dell'oggetto account dell'utente attualmente connesso
  • idToken - Token ID ricevuto come parte della risposta
  • idTokenClaims - Attestazioni di token ID rilevanti per MSAL
  • accessToken - Token di accesso o certificato SSH ricevuto come parte della risposta
  • fromCache - Valore booleano che indica se il token proviene dalla cache
  • expiresOn - Oggetto Data Javascript che rappresenta la scadenza relativa del token di accesso
  • extExpiresOn - Oggetto Data Javascript che rappresenta la scadenza relativa estesa del token di accesso in caso di interruzione del server
  • refreshOn - Oggetto Data Javascript che rappresenta l'ora relativa fino a quando non deve essere aggiornato un token di accesso
  • state - Valore passato dall'utente nella richiesta
  • familyId - Identificatore ID famiglia, in genere usato solo per i token di aggiornamento
  • requestId - ID richiesta restituito come parte della risposta
AuthorityOptions
AuthorizationCodePayload

Risposta restituita dopo l'elaborazione della stringa di query di risposta del codice o frammento.

AuthorizeResponse

Proprietà di risposta che possono essere restituite dall'endpoint /authorize

AzureCloudOptions

Opzioni specifiche di AzureCloudInstance

  • azureCloudInstance - Enumerazione stringa che fornisce una notazione breve per le autorità cloud pubbliche e soverign
  • tenant: provisioning per fornire le informazioni sul tenant
AzureRegion
AzureRegionConfiguration
BaseAuthRequest

BaseAuthRequest

  • authority : URL dell'autorità, il servizio token di sicurezza (STS) da cui MSAL acquisirà i token. Di default è https://login.microsoftonline.com/common. Se si usa la stessa autorità per tutte le richieste, l'autorità deve essere impostata sull'oggetto applicazione client e non richiedere, per evitare di risolvere più volte gli endpoint dell'autorità.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • authenticationScheme: tipo di token recuperato. Il valore predefinito è "Bearer". Può anche essere di tipo "pop" o "SSH".
  • claims: richiesta di attestazioni stringate che verrà aggiunta a tutte le chiamate /authorize e /token
  • shrClaims - Oggetto attestazioni stringate che verrà aggiunto a una richiesta HTTP firmata
  • shrNonce: timestamp generato dal server che è stato crittografato e codificato base64URL, che verrà aggiunto a una richiesta HTTP firmata.
  • shrOptions - Oggetto contenente le opzioni per la richiesta HTTP firmata
  • resourceRequestMethod : tipo di richiesta HTTP usato per richiedere dati dalla risorsa (ad esempio "GET", "POST" e così via). Usato per i flussi di prova del possesso.
  • resourceRequestUri: URI per cui verrà usato il token. Usato per i flussi di prova del possesso.
  • sshJwk: chiave Web JSON stringata che rappresenta una chiave pubblica che può essere firmata da un certificato SSH.
  • sshKid : ID chiave che identifica in modo univoco la chiave pubblica SSH indicata in precedenza.
  • azureCloudOptions - Enumerazioni di stringhe utili per gli utenti per fornire ID cloud pubblici/sovrani
  • requestedClaimsHash - Stringa hash SHA 256 della stringa di attestazioni richiesta, usata come parte di una chiave della cache dei token di accesso in modo che i token possano essere filtrati in base alle attestazioni richieste
  • tokenQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /token
  • tokenBodyParameters - Stringa per la mappa di stringhe di parametri personalizzati aggiunti al corpo della chiamata /token
  • storeInCache - Oggetto contenente valori booleani che indicano se archiviare i token nella cache o meno (il valore predefinito è true)
  • scenarioId - ID scenario per tenere traccia delle richieste utente personalizzate
  • popKid - ID chiave per identificare la chiave pubblica per la richiesta di token PoP
  • embeddedClientId - ID client incorporato. Se specificato, i parametri id client broker (brk_client_id) e URI di reindirizzamento (brk_redirect_uri) vengono impostati con i valori della configurazione, eseguendo l'override dei parametri aggiuntivi corrispondenti, se presenti.
  • httpMethod : metodo HTTP da usare per la richiesta /authorize. L'impostazione predefinita è GET, ma può essere impostata su POST se la richiesta richiede parametri del corpo
  • authorizePostBodyParameters : stringa per la mappa di stringhe dei parametri personalizzati aggiunti al corpo della chiamata /authorize quando httpMethod è impostato su POST
  • skipBrokerClaims: quando viene usato true e un flusso negoziato (ad esempio, quando sono presenti parametri broker o embeddedClientId), clientCapabilities dalla configurazione verrà escluso dalle attestazioni; ignorato per i flussi non negoziati.
CacheOptions

Usare questa opzione per configurare le preferenze della cache delle credenziali nell'oggetto ClientConfiguration

  • claimsBasedCachingEnabled: imposta se i token devono essere memorizzati nella cache in base all'hash delle attestazioni. Il valore predefinito è false.
CcsCredential
ClientInfo

Oggetto informazioni client costituito da: uid: id utente utid: ID tenant xms_tdbr: facoltativo, solo per tenant non statunitensi

CommonAuthorizationCodeRequest

Richiedere l'oggetto passato dall'utente per acquisire un token dal server scambiando un codice di autorizzazione valido (seconda parte del flusso del codice di autorizzazione OAuth2.0)

  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • claims: richiesta di attestazioni stringate che verrà aggiunta a tutte le chiamate /authorize e /token
  • authority: - URL dell'autorità, il servizio token di sicurezza (STS) da cui MSAL acquisirà i token. Se l'autorità è impostata sull'oggetto applicazione client, verrà eseguito l'override di tale valore. Se si esegue l'override del valore, la convalida dell'autorità verrà eseguita ogni volta. Se la stessa autorità verrà usata per tutte le richieste, impostare sull'oggetto applicazione anziché sulle richieste.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • redirectUri: URI di reindirizzamento dell'app, in cui l'autorità reindirizzerà a dopo che l'utente inserisce le credenziali e il consenso. Deve corrispondere esattamente a uno degli URI di reindirizzamento registrati nel portale
  • code : authorization_code che l'utente ha acquisito nella prima parte del flusso.
  • codeVerifier: la stessa code_verifier usata per ottenere il authorization_code. Obbligatorio se PKCE è stato usato nella richiesta di concessione del codice di autorizzazione. Per altre informazioni, vedere PKCE RFC: https://tools.ietf.org/html/rfc7636
  • resourceRequestMethod : tipo di richiesta HTTP usato per richiedere dati dalla risorsa (ad esempio "GET", "POST" e così via). Usato per i flussi di prova del possesso.
  • resourceRequestUri: URI per cui verrà usato il token. Usato per i flussi di prova del possesso.
  • enableSpaAuthCode: abilita l'acqusition di un codice di autorizzazione spa (solo client riservati)
  • tokenQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /token
CommonAuthorizationUrlRequest

Richiedere l'oggetto passato dall'utente per recuperare un codice dal server (primo passaggio del flusso di concessione del codice di autorizzazione)

  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • claims: richiesta di attestazioni stringate che verrà aggiunta a tutte le chiamate /authorize e /token
  • authority : URL dell'autorità da cui l'applicazione acquisisce i token.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • redirectUri: URI di reindirizzamento in cui è possibile ricevere risposte di autenticazione dall'applicazione. Deve corrispondere esattamente a uno degli URI di reindirizzamento registrati nel portale di Azure.
  • extraScopesToConsent: ambiti per una risorsa diversa quando l'utente necessita del consenso iniziale.
  • responseMode: specifica il metodo che deve essere usato per inviare il risultato dell'autenticazione all'app. Può essere una query, form_post o un frammento. Se non viene passato alcun valore, per impostazione predefinita viene eseguita una query.
  • codeChallenge: usato per proteggere la concessione del codice di autorizzazione tramite proof of key for Code Exchange (PKCE). Per altre informazioni, vedere PKCE RCF:https://tools.ietf.org/html/rfc7636
  • codeChallengeMethod: metodo usato per codificare il verificatore di codice per il parametro di verifica del codice. Può essere "normale" o "S256". Se escluso, si presuppone che la richiesta di verifica del codice sia testo non crittografato. Per altre informazioni, vedere PKCE RCF: https://tools.ietf.org/html/rfc7636
  • state: valore incluso nella richiesta restituita anche nella risposta del token. Un valore univoco generato in modo casuale viene in genere usato per prevenire attacchi falsi di richiesta intersito. Lo stato viene usato anche per codificare informazioni sullo stato dell'utente nell'app prima che si verifichi la richiesta di autenticazione.
  • prompt: indica il tipo di interazione dell'utente necessario. login: forza l'utente a immettere le proprie credenziali su tale richiesta, negando l'accesso Single Sign-On none: garantisce che l'utente non venga visualizzato alcun prompt interattivo. se la richiesta non può essere completata tramite Single Sign-On, l'endpoint restituirà un consenso di errore interaction_required: attiverà la finestra di dialogo di consenso OAuth dopo l'accesso dell'utente, chiedendo all'utente di concedere le autorizzazioni all'app select_account: interromperà l'accesso Single Sign-=On fornendo un'esperienza di selezione dell'account che elenca tutti gli account nella sessione o tutti gli account memorizzati o un'opzione per scegliere di usare un account diverso: indiricherà l'utente all'esperienza di creazione dell'account anziché all'esperienza di accesso no_session: non leggerà il token di sessione esistente durante l'autenticazione dell'utente. Dopo l'autenticazione dell'utente, EVO non creerà una nuova sessione per l'utente. SOLO PER USO INTERNO.
  • account: AccountInfo ottenuto da un'API getAccount. Verrà usato in determinati scenari per generare login_hint se non vengono forniti parametri loginHint e sid.
  • loginHint: può essere usato per pre-compilare il campo nome utente/indirizzo di posta elettronica della pagina di accesso per l'utente, se si conosce il nome utente/indirizzo di posta elettronica in anticipo. Spesso le app usano questo parametro durante la ripetizione dell'autenticazione, avendo già estratto il nome utente da un accesso precedente usando l'attestazione preferred_username.
  • sid : ID sessione, identificatore univoco per la sessione. Disponibile come attestazione facoltativa nei token ID.
  • domainHint: fornisce un suggerimento sul tenant o sul dominio che l'utente deve usare per accedere. Il valore dell'hint di dominio è un dominio registrato per il tenant.
  • extraQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /authorize
  • tokenQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /token
  • nonce: valore incluso nella richiesta restituita nel token ID. Un valore univoco generato in modo casuale viene in genere usato per attenuare gli attacchi di riproduzione.
  • resourceRequestMethod : tipo di richiesta HTTP usato per richiedere dati dalla risorsa (ad esempio "GET", "POST" e così via). Usato per i flussi di prova del possesso.
  • resourceRequestUri: URI per cui verrà usato il token. Usato per i flussi di prova del possesso.
CommonEndSessionRequest

CommonEndSessionRequest

  • account: oggetto account da disconnesso. Tutti i token associati a questo account verranno cancellati.
  • postLogoutRedirectUri: URI da passare a dopo la pagina di disconnessione.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • idTokenHint - Token ID usato da B2C per convalidare la disconnessione se richiesto dai criteri
  • state: valore incluso nella richiesta all'endpoint di disconnessione che verrà restituito nella stringa di query al reindirizzamento post disconnessione
  • logoutHint : stringa che specifica l'account disconnesso per ignorare la selezione dell'account server nella disconnessione
  • extraQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /authorize
CommonRefreshTokenRequest

CommonRefreshTokenRequest

  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • claims: richiesta di attestazioni stringate che verrà aggiunta a tutte le chiamate /authorize e /token
  • authority : URL dell'autorità, il servizio token di sicurezza (STS) da cui MSAL acquisirà i token.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • refreshToken: token di aggiornamento restituito da una richiesta precedente al provider di identità.
  • resourceRequestMethod : tipo di richiesta HTTP usato per richiedere dati dalla risorsa (ad esempio "GET", "POST" e così via). Usato per i flussi di prova del possesso.
  • resourceRequestUri: URI per cui verrà usato il token. Usato per i flussi di prova del possesso.
  • forceCache: forzaRE MSAL a memorizzare nella cache una risposta del flusso del token di aggiornamento quando non è presente alcun account nella cache. Usato per gli scenari di migrazione.
  • tokenQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /token
CommonSilentFlowRequest

Parametri SilentFlow passati dall'utente per recuperare le credenziali in modo invisibile all'utente

  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • claims: richiesta di attestazioni stringate che verrà aggiunta a tutte le chiamate /authorize e /token. Se incluso in una richiesta invisibile all'utente, la ricerca nella cache verrà ignorata e il token verrà aggiornato.
  • authority : URL dell'autorità da cui l'applicazione acquisisce i token.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • account: entità account per cercare le credenziali.
  • forceRefresh: forza le richieste invisibile all'utente a effettuare chiamate di rete se true.
  • resourceRequestMethod : tipo di richiesta HTTP usato per richiedere dati dalla risorsa (ad esempio "GET", "POST" e così via). Usato per i flussi di prova del possesso.
  • resourceRequestUri: URI per cui verrà usato il token. Usato per i flussi di prova del possesso.
  • tokenQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /token
CredentialEntity

Tipo di cache delle credenziali

CredentialFilter

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

ExternalTokenResponse

Oggetto risposta usato per il caricamento di token esterni nella cache.

  • token_type: indica il valore del tipo di token. L'unico tipo supportato da Azure AD è Bearer.
  • scope: ambiti per cui il access_token è valido.
  • expires_in: per quanto tempo il token di accesso è valido (in secondi).
  • id_token: token WEB JSON (JWT). L'app può decodificare i segmenti di questo token per richiedere informazioni sull'utente che ha eseguito l'accesso.
  • refresh_token: token di aggiornamento OAuth 2.0. L'app può usare questo token di acquisizione di token di accesso aggiuntivi dopo la scadenza del token di accesso corrente.
  • access_token: token di accesso richiesto. L'app può usare questo token per eseguire l'autenticazione nella risorsa protetta, ad esempio un'API Web.
  • client_info: oggetto informazioni client
IdTokenEntity

Tipo di cache dei token ID

InProgressPerformanceEvent
LibraryStateObject

Tipo che definisce l'oggetto stringato, codificato e inviato nel valore dello stato. Contiene quanto segue:

  • id : identificatore univoco per la richiesta
  • ts : timestamp per l'ora in cui è stata effettuata la richiesta. Usato per assicurarsi che la scadenza del token non venga calcolata in modo non corretto.
  • platformState: valore stringa inviato dalla piattaforma.
LoggerOptions

Usare questa opzione per configurare la registrazione eseguita da MSAL configurando le opzioni del logger nell'oggetto Configuration

  • loggerCallback - Callback per logger
  • piiLoggingEnabled - Imposta se la registrazione pii è abilitata
  • logLevel : imposta il livello in cui viene eseguita la registrazione
  • correlationId: imposta il correlationId stampato dal logger
NetworkRequestOptions

Opzioni consentite dalle API di richiesta di rete.

NetworkResponse
OIDCOptions

Opzioni per la modalità protocollo OIDC.

PerformanceCallbackFunction
PerformanceEvent

Misurazione delle prestazioni eseguita dalla libreria, inclusi i metadati relativi alla richiesta e all'applicazione.

PkceCodes

Il tipo PkceCodes descrive la struttura degli oggetti che contengono coppie di verifica e verifica del codice PKCE

QueueMeasurement

Tipo di misurazione coda

RefreshTokenEntity

Tipo di cache dei token di aggiornamento

RequestStateObject

Tipo che definisce l'oggetto stringaficato e codificato inviato al servizio nella richiesta di autorizzazione.

RequestThumbprint

Tipo che rappresenta un'identificazione personale della richiesta univoca.

ServerAuthorizationTokenResponse

Oggetto risposta deserializzato dalla richiesta del codice di autorizzazione del server.

  • token_type: indica il valore del tipo di token. Può essere bearer o pop.
  • scope: ambiti per cui il access_token è valido.
  • expires_in: per quanto tempo il token di accesso è valido (in secondi).
  • refresh_in: durata del rinvio a cui deve essere rinnovato un token, indipendentemente dalla scadenza.
  • ext_expires_in: per quanto tempo il token di accesso è valido (in secondi) se il server non risponde.
  • access_token: token di accesso richiesto. L'app può usare questo token per eseguire l'autenticazione nella risorsa protetta, ad esempio un'API Web.
  • refresh_token: token di aggiornamento OAuth 2.0. L'app può usare questo token di acquisizione di token di accesso aggiuntivi dopo la scadenza del token di accesso corrente.
  • id_token: token WEB JSON (JWT). L'app può decodificare i segmenti di questo token per richiedere informazioni sull'utente che ha eseguito l'accesso.
  • key_id: stringa che identifica in modo univoco una chiave pubblica a cui è associata la richiesta.

In caso di errore:

  • error: stringa di codice di errore che può essere usata per classificare i tipi di errori che si verificano e può essere usata per reagire agli errori.
  • error_description: messaggio di errore specifico che consente a uno sviluppatore di identificare la causa radice di un errore di autenticazione.
  • error_codes: elenco di codici di errore specifici del servizio token di sicurezza che possono essere utili nella diagnostica.
  • timestamp: ora in cui si è verificato l'errore.
  • trace_id: identificatore univoco per la richiesta che può essere utile nella diagnostica.
  • correlation_id: identificatore univoco per la richiesta che può essere utile nella diagnostica tra i componenti.
  • status: stato della risposta della richiesta di rete
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache

Controlla se i token devono essere archiviati nella cache o meno. Se impostato su false, i token possono essere ancora acquisiti e restituiti, ma non verranno memorizzati nella cache per il recupero successivo.

StringDict

Key-Value tipo per supportare queryParams, extraQueryParams e attestazioni

SubMeasurement
SystemOptions

Usare questa opzione per configurare le informazioni di rinnovo del token nell'oggetto Configuration

  • tokenRenewalOffsetSeconds - Imposta la finestra di offset necessaria per rinnovare il token prima della scadenza
TenantProfile

Dettagli dell'account che variano in base ai tenant per lo stesso utente

ThrottlingEntity
TokenClaims

Tipo che descrive le attestazioni del token ID note da MSAL.

TokenKeys
AppTokenProviderParameters

Oggetto di input per l'estendibilità IAppTokenProvider. MSAL creerà questo oggetto, che può essere usato per creare un Oggetto AppTokenProviderResult.

  • correlationId: ID di correlazione associato alla richiesta
  • tenantId: ID tenant per il quale deve essere specificato il token
  • ambiti: gli ambiti per i quali è necessario specificare il token
  • attestazioni: eventuali attestazioni aggiuntive che il token deve soddisfare
AppTokenProviderResult

Oggetto di output per l'estendibilità IAppTokenProvider.

  • accessToken: il token di accesso effettivo, in genere in formato JWT, che soddisfa i dati della richiesta AppTokenProviderParameters
  • expiresInSeconds: per quanto tempo i token hanno prima della scadenza, in secondi. Analogamente al campo "expires_in" in una risposta del token AAD.
  • refreshInSeconds: per quanto tempo il token deve essere aggiornato in modo proattivo. Analogamente al campo "refresh_in" in una risposta del token AAD.
ClientAssertion

Credenziali di asserzione client per client riservati

ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest

CommonClientCredentialRequest

  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • authority : URL dell'autorità, il servizio token di sicurezza (STS) da cui MSAL acquisirà i token.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • skipCache: ignorare la ricerca della cache dei token e forzare la richiesta all'autorità per ottenere un nuovo token. Il valore predefinito è falso.
  • preferredAzureRegionOptions - Opzioni dell'area di Azure preferita dell'utente
  • tokenQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /token
CommonDeviceCodeRequest

Parametri per il flusso del codice del dispositivo Oauth2.

  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • authority: - URL dell'autorità, il servizio token di sicurezza (STS) da cui MSAL acquisirà i token. Se l'autorità è impostata sull'oggetto applicazione client, verrà eseguito l'override di tale valore. Se si esegue l'override del valore, la convalida dell'autorità verrà eseguita ogni volta. Se la stessa autorità verrà usata per tutte le richieste, impostare sull'oggetto applicazione anziché sulle richieste.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • deviceCodeCallback: callback contenente la risposta del codice del dispositivo. Il messaggio deve essere visualizzato all'utente finale. L'utente finale può quindi passare al verification_uri, immettere il user_code e le credenziali di input.
  • cancel: valore booleano per annullare il polling dell'endpoint del codice del dispositivo. Mentre l'utente esegue l'autenticazione in un dispositivo separato, MSAL esegue il polling dell'endpoint del token del servizio token di sicurezza per l'intervallo specificato nella risposta al codice del dispositivo (in genere 15 minuti). Per interrompere il polling e annullare la richiesta, impostare cancel=true.
  • resourceRequestMethod : tipo di richiesta HTTP usato per richiedere dati dalla risorsa (ad esempio "GET", "POST" e così via). Usato per i flussi di prova del possesso.
  • resourceRequestUri: URI per cui verrà usato il token. Usato per i flussi di prova del possesso.
  • timeout: periodo di timeout in secondi in cui l'utente configura in modo esplicito per il polling dell'endpoint del codice del dispositivo. Alla fine di questo periodo; supponendo che il codice del dispositivo non sia ancora scaduto; il polling del codice del dispositivo viene arrestato e la richiesta annullata. La finestra di scadenza del codice del dispositivo avrà sempre la precedenza su questo periodo impostato.
  • extraQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla stringa di query
CommonOnBehalfOfRequest
  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • authority : URL dell'autorità, il servizio token di sicurezza (STS) da cui MSAL acquisirà i token.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • oboAssertion: token di accesso inviato all'API di livello intermedio. Questo token deve avere un gruppo di destinatari dell'app che effettua questa richiesta OBO.
  • skipCache: ignorare la ricerca della cache dei token e forzare la richiesta all'autorità per ottenere un nuovo token. Il valore predefinito è falso.
  • tokenQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /token
CommonUsernamePasswordRequest

Parametri CommonUsernamePassword passati dall'utente per recuperare le credenziali Nota: l'ultima procedura di sicurezza OAuth 2.0 Security Best Current Practice non consente completamente la concessione della password. Questo flusso viene aggiunto per i test interni.

  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • claims: richiesta di attestazioni stringate che verrà aggiunta a tutte le chiamate /authorize e /token. Se incluso in una richiesta invisibile all'utente, la ricerca nella cache verrà ignorata e il token verrà aggiornato.
  • authority : URL dell'autorità da cui l'applicazione acquisisce i token.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • username : nome utente del client
  • password - credenziali
  • tokenQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla chiamata /token
DeviceCodeResponse

DeviceCode restituito dall'endpoint del codice del dispositivo del servizio token di sicurezza contenente le informazioni necessarie per il flusso del codice del dispositivo.

  • userCode: codice che l'utente deve fornire durante l'autenticazione all'URI di verifica
  • deviceCode: codice che deve essere incluso nella richiesta per il token di accesso
  • verificationUri: URI in cui l'utente può eseguire l'autenticazione
  • expiresIn: scadenza del codice del dispositivo in secondi
  • interval: intervallo in cui deve essere eseguito il polling del servizio token di sicurezza in corrispondenza del quale deve essere eseguito il polling
  • messaggio: messaggio che deve essere visualizzato all'utente
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

Enumerazioni

LogLevel

Livello di messaggio di log.

PerformanceEventStatus

Stato dell'evento di prestazioni.

PerformanceEvents

L'enumerazione delle operazioni instrumentate da ha le prestazioni misurate da PerformanceClient.

Funzioni

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

Funzione per compilare un oggetto informazioni client dalla stringa clientInfo del server

buildClientInfoFromHomeAccountId(string)

Funzione per compilare un oggetto informazioni client dalla stringa homeAccountId memorizzata nella cache

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

Creare un profilo tenant

createAuthError(string, string)
createCacheError(unknown)

Funzione helper per eseguire il wrapping degli errori del browser in un oggetto CacheError

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

Crea un interactionRequiredAuthError

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

Crea un oggetto NetworkError per una richiesta di rete non riuscita

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

Ottiene tenantId dalle attestazioni del token ID disponibili da impostare come area di autenticazione delle credenziali con la precedenza seguente:

  1. tid: se il token viene acquisito da un tenant di Azure AD tid sarà presente
  2. tfp: se il token viene acquisito da un tenant B2C moderno tfp deve essere presente
  3. acr: se il token viene acquisito da un acr tenant B2C legacy deve essere presente downcased per soddisfare i requisiti di confronto senza distinzione tra maiuscole e minuscole dell'area di autenticazione
tenantIdMatchesHomeTenant(string, string)

Restituisce true se tenantId corrisponde alla parte utid di homeAccountId

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Sostituisce le informazioni sull'account che variano in base al profilo tenant originato dalle attestazioni del token ID passate con le informazioni sull'account specifico del tenant

Variabili

AADAuthorityConstants

Costanti stringa correlate all'autorità di AAD

AuthenticationScheme

Tipo di richiesta di autenticazione

AuthorityType

Tipi di autorità supportati da MSAL.

AzureCloudInstance
CacheAccountType

Tipi di account nella cache

CacheOutcome

Specifica il motivo del recupero del token di accesso dal provider di identità

CacheType

Combinare tutti i tipi di cache

CcsCredentialType
ClaimsRequestKeys

Chiavi di richiesta di attestazioni

CredentialType

Tipo di credenziale archiviato nella cache

EncodingTypes
GrantType

grant_type consentiti

HeaderNames

Nomi di intestazione della richiesta

HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType

Valori consentiti per response_type

PasswordGrantConstants

Parametri di concessione delle password

PersistentCacheKeys

Chiavi della cache persistenti MSAL che rimangono durante l'accesso dell'utente.

ProtocolMode

Modalità di protocollo supportate da MSAL.

ResponseMode

valori consentiti per response_mode

ServerResponseType

valori consentiti per il tipo di risposta del server

AuthErrorMessage

Classe AuthErrorMessage contenente costanti stringa usate da codici di errore e messaggi.

ClientAuthErrorMessage

Costanti stringa usate da codici di errore e messaggi.

ClientConfigurationErrorMessage

Classe ClientConfigurationErrorMessage contenente costanti stringa usate da codici di errore e messaggi.

CodeChallengeMethodValues

valori consentiti per codeVerifier

Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage

Errori di interazione necessari definiti dall'SDK

OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue

è stato considerato come effettuare questa "enumerazione" nella richiesta anziché nella stringa, tuttavia sembra che l'elenco consentito di valori di prompt continua a cambiare negli ultimi due anni. Esistono anche alcuni valori di richiesta non documentati per alcuni partner interni, quindi la scelta del tipo "string" generico anziché dell'enumerazione

StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants

Costanti correlate alla limitazione

version

Dettagli funzione

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

Parametri

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

Valori restituiti

AccountEntity

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

Funzione per compilare un oggetto informazioni client dalla stringa clientInfo del server

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

Parametri

rawClientInfo

string

base64Decode

(input: string) => string

Valori restituiti

buildClientInfoFromHomeAccountId(string)

Funzione per compilare un oggetto informazioni client dalla stringa homeAccountId memorizzata nella cache

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Parametri

homeAccountId

string

Valori restituiti

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

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

Parametri

authOptions

Partial<AuthorityOptions>

Valori restituiti

buildTenantProfile(string, string, string, TokenClaims)

Creare un profilo tenant

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

Parametri

homeAccountId

string

Identificatore dell'account home per questo oggetto account

localAccountId

string

Identificatore dell'account locale per questo oggetto account

tenantId

string

Tenant completo o ID organizzazione a cui appartiene l'account

idTokenClaims
TokenClaims

Attestazioni dal token ID

Valori restituiti

createAuthError(string, string)

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

Parametri

code

string

additionalMessage

string

Valori restituiti

createCacheError(unknown)

Funzione helper per eseguire il wrapping degli errori del browser in un oggetto CacheError

function createCacheError(e: unknown): CacheError

Parametri

e

unknown

Valori restituiti

createClientAuthError(string, string)

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

Parametri

errorCode

string

additionalMessage

string

Valori restituiti

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Parametri

errorCode

string

Valori restituiti

createInteractionRequiredAuthError(string)

Crea un interactionRequiredAuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Parametri

errorCode

string

Valori restituiti

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

Crea un oggetto NetworkError per una richiesta di rete non riuscita

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

Parametri

error
AuthError

Errore durante il quale viene restituito il chiamante

httpStatus

number

Codice di stato della richiesta di rete

responseHeaders

Record<string, string>

Intestazioni di risposta della richiesta di rete, se disponibili

additionalError

Error

Valori restituiti

Oggetto NetworkError

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Parametri

authorityUri

string

Valori restituiti

string

getRequestThumbprint(string, BaseAuthRequest, string)

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

Parametri

clientId

string

request
BaseAuthRequest
homeAccountId

string

Valori restituiti

getTenantIdFromIdTokenClaims(TokenClaims)

Ottiene tenantId dalle attestazioni del token ID disponibili da impostare come area di autenticazione delle credenziali con la precedenza seguente:

  1. tid: se il token viene acquisito da un tenant di Azure AD tid sarà presente
  2. tfp: se il token viene acquisito da un tenant B2C moderno tfp deve essere presente
  3. acr: se il token viene acquisito da un acr tenant B2C legacy deve essere presente downcased per soddisfare i requisiti di confronto senza distinzione tra maiuscole e minuscole dell'area di autenticazione
function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

Parametri

idTokenClaims
TokenClaims

Valori restituiti

string | null

tenantIdMatchesHomeTenant(string, string)

Restituisce true se tenantId corrisponde alla parte utid di homeAccountId

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

Parametri

tenantId

string

homeAccountId

string

Valori restituiti

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Sostituisce le informazioni sull'account che variano in base al profilo tenant originato dalle attestazioni del token ID passate con le informazioni sull'account specifico del tenant

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

Parametri

baseAccountInfo
AccountInfo
tenantProfile
TenantProfile
idTokenClaims
TokenClaims
idTokenSecret

string

Valori restituiti

Dettagli delle variabili

AADAuthorityConstants

Costanti stringa correlate all'autorità di AAD

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

Tipo

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

AuthenticationScheme

Tipo di richiesta di autenticazione

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

Tipo

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

AuthorityType

Tipi di autorità supportati da MSAL.

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

Tipo

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

Tipo

{ 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

Tipi di account nella cache

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

Tipo

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

CacheOutcome

Specifica il motivo del recupero del token di accesso dal provider di identità

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

Tipo

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

CacheType

Combinare tutti i tipi di cache

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

Tipo

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

Tipo

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

ClaimsRequestKeys

Chiavi di richiesta di attestazioni

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

Tipo

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

CredentialType

Tipo di credenziale archiviato nella cache

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

Tipo

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

Tipo

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

GrantType

grant_type consentiti

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

Tipo

{ 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

Nomi di intestazione della richiesta

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

Tipo

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

Tipo

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

Tipo

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

Tipo

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

OAuthResponseType

Valori consentiti per response_type

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

Tipo

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

PasswordGrantConstants

Parametri di concessione delle password

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

Tipo

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

PersistentCacheKeys

Chiavi della cache persistenti MSAL che rimangono durante l'accesso dell'utente.

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

Tipo

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

ProtocolMode

Modalità di protocollo supportate da MSAL.

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

Tipo

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

ResponseMode

valori consentiti per response_mode

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

Tipo

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

ServerResponseType

Avviso

Questa API è ora deprecata.

Use ResponseMode instead

valori consentiti per il tipo di risposta del server

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

Tipo

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

AuthErrorMessage

Avviso

Questa API è ora deprecata.

Use AuthErrorCodes instead

Classe AuthErrorMessage contenente costanti stringa usate da codici di errore e messaggi.

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

Tipo

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

ClientAuthErrorMessage

Avviso

Questa API è ora deprecata.

Use ClientAuthErrorCodes instead

Costanti stringa usate da codici di errore e messaggi.

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

Tipo

{ 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

Avviso

Questa API è ora deprecata.

Use ClientConfigurationErrorCodes instead

Classe ClientConfigurationErrorMessage contenente costanti stringa usate da codici di errore e messaggi.

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

Tipo

{ 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

valori consentiti per codeVerifier

CodeChallengeMethodValues: { PLAIN: string, S256: string }

Tipo

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

Tipo

{ 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

Tipo

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Tipo

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

Tipo

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

Tipo

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

Tipo

ReadonlySet<string>

InteractionRequiredAuthErrorMessage

Avviso

Questa API è ora deprecata.

Use InteractionRequiredAuthErrorCodes instead

Errori di interazione necessari definiti dall'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 } }

Tipo

{ 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[]

Tipo

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

Tipo

86400000

PromptValue

è stato considerato come effettuare questa "enumerazione" nella richiesta anziché nella stringa, tuttavia sembra che l'elenco consentito di valori di prompt continua a cambiare negli ultimi due anni. Esistono anche alcuni valori di richiesta non documentati per alcuni partner interni, quindi la scelta del tipo "string" generico anziché dell'enumerazione

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

Tipo

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

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

Tipo

THE_FAMILY_ID

THE_FAMILY_ID: "1"

Tipo

"1"

ThrottlingConstants

Costanti correlate alla limitazione

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

Tipo

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

Tipo

"15.17.0"