@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:
|
| ActiveAccountFilters | |
| AppMetadataEntity |
Tipo di cache dei metadati dell'app |
| ApplicationTelemetry |
Informazioni di telemetria inviate su richiesta
|
| AuthenticationResult |
Risultato restituito dall'endpoint del token dell'autorità.
|
| 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
|
| AzureRegion | |
| AzureRegionConfiguration | |
| BaseAuthRequest |
BaseAuthRequest
|
| CacheOptions |
Usare questa opzione per configurare le preferenze della cache delle credenziali nell'oggetto ClientConfiguration
|
| 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)
|
| CommonAuthorizationUrlRequest |
Richiedere l'oggetto passato dall'utente per recuperare un codice dal server (primo passaggio del flusso di concessione del codice di autorizzazione)
|
| CommonEndSessionRequest |
CommonEndSessionRequest
|
| CommonRefreshTokenRequest |
CommonRefreshTokenRequest
|
| CommonSilentFlowRequest |
Parametri SilentFlow passati dall'utente per recuperare le credenziali in modo invisibile all'utente
|
| 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.
|
| 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:
|
| LoggerOptions |
Usare questa opzione per configurare la registrazione eseguita da MSAL configurando le opzioni del logger nell'oggetto Configuration
|
| 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.
In caso di errore:
|
| 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
|
| 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.
|
| AppTokenProviderResult |
Oggetto di output per l'estendibilità IAppTokenProvider.
|
| ClientAssertion |
Credenziali di asserzione client per client riservati |
| ClientAssertionCallback | |
| ClientAssertionConfig | |
| CommonClientCredentialRequest |
CommonClientCredentialRequest
|
| CommonDeviceCodeRequest |
Parametri per il flusso del codice del dispositivo Oauth2.
|
| CommonOnBehalfOfRequest |
|
| 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.
|
| 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.
|
| 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
| build |
|
| build |
Funzione per compilare un oggetto informazioni client dalla stringa clientInfo del server |
| build |
Funzione per compilare un oggetto informazioni client dalla stringa homeAccountId memorizzata nella cache |
| build |
|
| build |
Creare un profilo tenant |
| create |
|
| create |
Funzione helper per eseguire il wrapping degli errori del browser in un oggetto CacheError |
| create |
|
| create |
|
| create |
Crea un interactionRequiredAuthError |
| create |
Crea un oggetto NetworkError per una richiesta di rete non riuscita |
| format |
|
| get |
|
| get |
Ottiene tenantId dalle attestazioni del token ID disponibili da impostare come area di autenticazione delle credenziali con la precedenza seguente:
|
| tenant |
Restituisce true se tenantId corrisponde alla parte utid di homeAccountId |
| update |
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
| AADAuthority |
Costanti stringa correlate all'autorità di AAD |
| Authentication |
Tipo di richiesta di autenticazione |
| Authority |
Tipi di autorità supportati da MSAL. |
| Azure |
|
| Cache |
Tipi di account nella cache |
| Cache |
Specifica il motivo del recupero del token di accesso dal provider di identità |
| Cache |
Combinare tutti i tipi di cache |
| Ccs |
|
| Claims |
Chiavi di richiesta di attestazioni |
| Credential |
Tipo di credenziale archiviato nella cache |
| Encoding |
|
| Grant |
grant_type consentiti |
| Header |
Nomi di intestazione della richiesta |
| Http |
|
| Http |
|
| Json |
|
| OAuth |
Valori consentiti per response_type |
| Password |
Parametri di concessione delle password |
| Persistent |
Chiavi della cache persistenti MSAL che rimangono durante l'accesso dell'utente. |
| Protocol |
Modalità di protocollo supportate da MSAL. |
| Response |
valori consentiti per response_mode |
| Server |
valori consentiti per il tipo di risposta del server |
| Auth |
Classe AuthErrorMessage contenente costanti stringa usate da codici di errore e messaggi. |
| Client |
Costanti stringa usate da codici di errore e messaggi. |
| Client |
Classe ClientConfigurationErrorMessage contenente costanti stringa usate da codici di errore e messaggi. |
| Code |
valori consentiti per codeVerifier |
| Constants | |
| DEFAULT_CRYPTO_IMPLEMENTATION | |
| DEFAULT_SYSTEM_OPTIONS | |
| DEFAULT_TOKEN_RENEWAL_OFFSET_SEC | |
| Errors | |
| Int |
|
| Interaction |
Errori di interazione necessari definiti dall'SDK |
| OIDC_DEFAULT_SCOPES | |
| ONE_DAY_IN_MS | |
| Prompt |
è 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 |
| Stubbed |
|
| THE_FAMILY_ID | |
| Throttling |
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:
- tid: se il token viene acquisito da un tenant di Azure AD tid sarà presente
- tfp: se il token viene acquisito da un tenant B2C moderno tfp deve essere presente
- 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_SYSTEM_OPTIONS
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
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"