@azure/msal-common package
Classes
| AuthError |
Classe d’erreur générale levée par la bibliothèque MSAL.js. |
| AuthenticationHeaderParser |
Il s’agit d’une classe d’assistance qui analyse les en-têtes d’authentification de réponse HTTP pris en charge pour extraire et retourner des valeurs de défi d’en-tête qui peuvent être utilisées en dehors des flux d’autorisation de base. |
| CacheError |
Erreur levée en cas d’erreur avec le cache |
| ClientAuthError |
Erreur levée lorsqu’il y a une erreur dans le code client en cours d’exécution sur le navigateur. |
| ClientConfigurationError |
Erreur levée lorsqu’une erreur se produit lors de la configuration de la bibliothèque MSAL.js. |
| InteractionRequiredAuthError |
Erreur levée lorsque l’interaction utilisateur est requise. |
| Logger |
Classe qui facilite la journalisation des messages à un endroit spécifique. |
| NetworkError |
Représente les erreurs liées au réseau |
| PerformanceClient | |
| PlatformBrokerError |
Classe d’erreur pour les erreurs MSAL Runtime qui conservent des informations détaillées sur le répartiteur |
| ProtocolUtils |
Classe qui fournit des helpers pour les valeurs spécifiques du protocole OAuth 2.0 |
| ScopeSet |
La classe ScopeSet crée un ensemble d’étendues. Les étendues ne respectent pas la casse, les valeurs uniques, de sorte que l’objet Set dans JS est le plus judicieux à implémenter pour cette classe. Toutes les étendues sont coupées et converties en chaînes minuscules dans les fonctions d’intersection et d’union pour garantir l’unicité des chaînes. |
| ServerError |
Erreur levée lorsqu’il existe une erreur avec le code du serveur, par exemple, une indisponibilité. |
| StubPerformanceClient | |
| UrlString |
Classe d’objet URL qui peut effectuer différentes transformations sur des chaînes d’URL. |
| TokenCacheContext |
Cette instance de classe permet de suivre les modifications de mémoire facilitant les décisions de lecture et d’écriture dans le cache persistant |
Interfaces
| ICrypto |
Interface pour les fonctions de chiffrement utilisées par la bibliothèque |
| ILoggerCallback | |
| INetworkModule |
Interface réseau cliente pour envoyer des demandes back-end. |
| IPerformanceClient | |
| IPerformanceMeasurement | |
| IUri |
Interface qui décrit les composants d’URI. |
| PreQueueEvent | |
| IAppTokenProvider | |
| ICachePlugin | |
| IGuidGenerator | |
| INativeBrokerPlugin | |
| ISerializableTokenCache | |
Alias de type
| AccessTokenEntity |
Type de cache de jeton d’accès |
| AccountFilter |
Compte : <home_account_id-environment-realm<>><*> |
| AccountInfo |
Objet account avec la signature suivante :
|
| ActiveAccountFilters | |
| AppMetadataEntity |
Type de cache de métadonnées d’application |
| ApplicationTelemetry |
Informations de télémétrie envoyées à la demande
|
| AuthenticationResult |
Résultat retourné à partir du point de terminaison de jeton de l’autorité.
|
| AuthorityOptions | |
| AuthorizationCodePayload |
Réponse retournée après le traitement de la chaîne ou du fragment de requête de réponse de code. |
| AuthorizeResponse |
Propriétés de réponse qui peuvent être retournées par le point de terminaison /authorize |
| AzureCloudOptions |
Options spécifiques à AzureCloudInstance
|
| AzureRegion | |
| AzureRegionConfiguration | |
| BaseAuthRequest |
BaseAuthRequest
|
| CacheOptions |
Utilisez-le pour configurer les préférences de cache d’informations d’identification dans l’objet ClientConfiguration
|
| CcsCredential | |
| ClientInfo |
Objet d’informations client qui se compose de : uid : id d’utilisateur utid : ID de locataire xms_tdbr : facultatif, uniquement pour les locataires non-AMÉRICAINs |
| CommonAuthorizationCodeRequest |
Demander à l’utilisateur d’acquérir un jeton auprès du serveur qui échange un code d’autorisation valide (deuxième étape du flux de code d’autorisation OAuth2.0)
|
| CommonAuthorizationUrlRequest |
Demander l’objet transmis par l’utilisateur pour récupérer un code à partir du serveur (première étape du flux d’octroi du code d’autorisation)
|
| CommonEndSessionRequest |
CommonEndSessionRequest
|
| CommonRefreshTokenRequest |
CommonRefreshTokenRequest
|
| CommonSilentFlowRequest |
Paramètres SilentFlow transmis par l’utilisateur pour récupérer les informations d’identification en mode silencieux
|
| CredentialEntity |
Type de cache d’informations d’identification |
| CredentialFilter |
Informations d’identification : <home_account_id*>-<environment-credential_type-client_id-realm<>>><<*>-target*>-<<scheme*> |
| ExternalTokenResponse |
Objet response utilisé pour charger des jetons externes dans le cache.
|
| IdTokenEntity |
Type de cache de jeton d’ID |
| InProgressPerformanceEvent | |
| LibraryStateObject |
Type qui définit l’objet qui est stringified, encodé et envoyé dans la valeur d’état. Contient les éléments suivants :
|
| LoggerOptions |
Utilisez-le pour configurer la journalisation que MSAL effectue, en configurant les options d’enregistreur d’événements dans l’objet Configuration
|
| NetworkRequestOptions |
Options autorisées par les API de requête réseau. |
| NetworkResponse | |
| OIDCOptions |
Options pour le mode de protocole OIDC. |
| PerformanceCallbackFunction | |
| PerformanceEvent |
Mesure des performances effectuée par la bibliothèque, y compris les métadonnées relatives à la demande et à l’application. |
| PkceCodes |
Le type PkceCodes décrit la structure des objets qui contiennent des paires de code PKCE et de vérificateur |
| QueueMeasurement |
Type de mesure de file d’attente |
| RefreshTokenEntity |
Type de cache de jeton d’actualisation |
| RequestStateObject |
Type qui définit l’objet stringified et encodé envoyé au service dans la demande d’autorisation. |
| RequestThumbprint |
Type représentant une empreinte numérique de requête unique. |
| ServerAuthorizationTokenResponse |
Objet de réponse désérialisé à partir de la demande de code d’autorisation du serveur.
En cas d’erreur :
|
| ServerTelemetryEntity | |
| ServerTelemetryRequest | |
| ShrOptions | |
| SignedHttpRequest | |
| SignedHttpRequestParameters | |
| StaticAuthorityOptions | |
| StoreInCache |
Contrôle si les jetons doivent être stockés dans le cache ou non. Si la valeur est false, les jetons peuvent toujours être acquis et retournés, mais ne seront pas mis en cache pour une récupération ultérieure. |
| StringDict |
Key-Value type pour prendre en charge queryParams, extraQueryParams et revendications |
| SubMeasurement | |
| SystemOptions |
Utilisez cette option pour configurer les informations de renouvellement de jeton dans l’objet Configuration
|
| TenantProfile |
Détails du compte qui varient selon les locataires pour le même utilisateur |
| ThrottlingEntity | |
| TokenClaims |
Type qui décrit les revendications de jeton d’ID connues par MSAL. |
| TokenKeys | |
| AppTokenProviderParameters |
Objet d’entrée pour iAppTokenProvider extensiblity. MSAL crée cet objet, qui peut être utilisé pour aider à créer un AppTokenProviderResult.
|
| AppTokenProviderResult |
Objet output pour IAppTokenProvider extensiblity.
|
| ClientAssertion |
Informations d’identification d’assertion du client pour les clients confidentiels |
| ClientAssertionCallback | |
| ClientAssertionConfig | |
| CommonClientCredentialRequest |
CommonClientCredentialRequest
|
| CommonDeviceCodeRequest |
Paramètres du flux de code d’appareil Oauth2.
|
| CommonOnBehalfOfRequest |
|
| CommonUsernamePasswordRequest |
Paramètres CommonUsernamePassword transmis par l’utilisateur pour récupérer les informations d’identification Remarque : la dernière pratique actuelle de sécurité OAuth 2.0 interdit entièrement l’octroi de mot de passe. Ce flux est ajouté pour les tests internes.
|
| DeviceCodeResponse |
DeviceCode retourné par le point de terminaison de code d’appareil du service de jeton de sécurité contenant les informations nécessaires pour le flux de code de l’appareil.
|
| NativeRequest | |
| NativeSignOutRequest | |
| ServerDeviceCodeResponse | |
Énumérations
| LogLevel |
Niveau du message de journal. |
| PerformanceEventStatus |
État de l’événement de performances. |
| PerformanceEvents |
L’énumération des opérations instrumentées par leurs performances est mesurée par PerformanceClient. |
Functions
| build |
|
| build |
Fonction pour générer un objet d’informations client à partir de la chaîne clientInfo du serveur |
| build |
Fonction pour générer un objet d’informations client à partir de la chaîne homeAccountId mise en cache |
| build |
|
| build |
Générer un profil de locataire |
| create |
|
| create |
Fonction d’assistance pour encapsuler les erreurs de navigateur dans un objet CacheError |
| create |
|
| create |
|
| create |
Crée une interactionRequiredAuthError |
| create |
Crée un objet NetworkError pour une requête réseau ayant échoué |
| format |
|
| get |
|
| get |
Obtient tenantId à partir des revendications de jeton d’ID disponibles à définir comme domaine d’informations d’identification avec la priorité suivante :
|
| tenant |
Retourne true si tenantId correspond à la partie utid de homeAccountId |
| update |
Remplace les informations de compte qui varient selon le profil de locataire provenant des revendications de jeton d’ID transmises par les informations de compte spécifiques au locataire |
Variables
| AADAuthority |
Constantes de chaîne liées à l’autorité AAD |
| Authentication |
Type de la demande d’authentification |
| Authority |
Types d’autorité pris en charge par MSAL. |
| Azure |
|
| Cache |
Types de comptes dans le cache |
| Cache |
Spécifie la raison de l’extraction du jeton d’accès à partir du fournisseur d’identité |
| Cache |
Combiner tous les types de cache |
| Ccs |
|
| Claims |
Clés de demande de revendications |
| Credential |
Type d’informations d’identification stocké dans le cache |
| Encoding |
|
| Grant |
grant_type autorisé |
| Header |
Noms d’en-tête de requête |
| Http |
|
| Http |
|
| Json |
|
| OAuth |
Valeurs autorisées pour response_type |
| Password |
Paramètres d’octroi de mot de passe |
| Persistent |
Clés de cache persistantes MSAL qui restent pendant la connexion de l’utilisateur. |
| Protocol |
Modes de protocole pris en charge par MSAL. |
| Response |
valeurs autorisées pour response_mode |
| Server |
valeurs autorisées pour le type de réponse du serveur |
| Auth |
Classe AuthErrorMessage contenant des constantes de chaîne utilisées par les codes d’erreur et les messages. |
| Client |
Constantes de chaîne utilisées par les codes d’erreur et les messages. |
| Client |
Classe ClientConfigurationErrorMessage contenant des constantes de chaîne utilisées par les codes d’erreur et les messages. |
| Code |
valeurs autorisées pour codeVerifier |
| Constants | |
| DEFAULT_CRYPTO_IMPLEMENTATION | |
| DEFAULT_SYSTEM_OPTIONS | |
| DEFAULT_TOKEN_RENEWAL_OFFSET_SEC | |
| Errors | |
| Int |
|
| Interaction |
Erreurs requises d’interaction définies par le Kit de développement logiciel (SDK) |
| OIDC_DEFAULT_SCOPES | |
| ONE_DAY_IN_MS | |
| Prompt |
nous avons envisagé de rendre cette « énumération » dans la requête au lieu de chaîne, mais il semble que la liste autorisée des valeurs d’invite change au cours des deux dernières années. Il existe également des valeurs d’invite non documentées pour certains partenaires internes. Par conséquent, le choix du type générique « string » au lieu de « enum » |
| Stubbed |
|
| THE_FAMILY_ID | |
| Throttling |
Constantes liées à la limitation |
| version |
Informations relatives à la fonction
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
Paramètres
- 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
Retours
AccountEntity
buildClientInfo(string, (input: string) => string)
Fonction pour générer un objet d’informations client à partir de la chaîne clientInfo du serveur
function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo
Paramètres
- rawClientInfo
-
string
- base64Decode
-
(input: string) => string
Retours
buildClientInfoFromHomeAccountId(string)
Fonction pour générer un objet d’informations client à partir de la chaîne homeAccountId mise en cache
function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo
Paramètres
- homeAccountId
-
string
Retours
buildStaticAuthorityOptions(Partial<AuthorityOptions>)
function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions
Paramètres
- authOptions
-
Partial<AuthorityOptions>
Retours
buildTenantProfile(string, string, string, TokenClaims)
Générer un profil de locataire
function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile
Paramètres
- homeAccountId
-
string
Identificateur de compte d’accueil pour cet objet de compte
- localAccountId
-
string
Identificateur de compte local pour cet objet de compte
- tenantId
-
string
Id d’organisation ou locataire complet auquel appartient ce compte
- idTokenClaims
- TokenClaims
Revendications du jeton d’ID
Retours
createAuthError(string, string)
function createAuthError(code: string, additionalMessage?: string): AuthError
Paramètres
- code
-
string
- additionalMessage
-
string
Retours
createCacheError(unknown)
Fonction d’assistance pour encapsuler les erreurs de navigateur dans un objet CacheError
function createCacheError(e: unknown): CacheError
Paramètres
- e
-
unknown
Retours
createClientAuthError(string, string)
function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError
Paramètres
- errorCode
-
string
- additionalMessage
-
string
Retours
createClientConfigurationError(string)
function createClientConfigurationError(errorCode: string): ClientConfigurationError
Paramètres
- errorCode
-
string
Retours
createInteractionRequiredAuthError(string)
Crée une interactionRequiredAuthError
function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError
Paramètres
- errorCode
-
string
Retours
createNetworkError(AuthError, number, Record<string, string>, Error)
Crée un objet NetworkError pour une requête réseau ayant échoué
function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError
Paramètres
- error
- AuthError
Erreur à revenir à l’appelant
- httpStatus
-
number
Code d’état de la requête réseau
- responseHeaders
-
Record<string, string>
En-têtes de réponse de la requête réseau, le cas échéant
- additionalError
-
Error
Retours
Objet NetworkError
formatAuthorityUri(string)
function formatAuthorityUri(authorityUri: string): string
Paramètres
- authorityUri
-
string
Retours
string
getRequestThumbprint(string, BaseAuthRequest, string)
function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint
Paramètres
- clientId
-
string
- request
- BaseAuthRequest
- homeAccountId
-
string
Retours
getTenantIdFromIdTokenClaims(TokenClaims)
Obtient tenantId à partir des revendications de jeton d’ID disponibles à définir comme domaine d’informations d’identification avec la priorité suivante :
- tid : si le jeton est acquis à partir d’un locataire AZURE AD tid sera présent
- tfp : si le jeton est acquis à partir d’une tfp de locataire B2C moderne doit être présent
- acr : si le jeton est acquis à partir d’un acr de locataire B2C hérité doit être présent en minuscules pour correspondre aux exigences de comparaison sans respect de la casse du domaine
function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null
Paramètres
- idTokenClaims
- TokenClaims
Retours
string | null
tenantIdMatchesHomeTenant(string, string)
Retourne true si tenantId correspond à la partie utid de homeAccountId
function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean
Paramètres
- tenantId
-
string
- homeAccountId
-
string
Retours
boolean
updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)
Remplace les informations de compte qui varient selon le profil de locataire provenant des revendications de jeton d’ID transmises par les informations de compte spécifiques au locataire
function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo
Paramètres
- baseAccountInfo
- AccountInfo
- tenantProfile
- TenantProfile
- idTokenClaims
- TokenClaims
- idTokenSecret
-
string
Retours
Détails de variable
AADAuthorityConstants
Constantes de chaîne liées à l’autorité AAD
AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }
Type
{ COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }
AuthenticationScheme
Type de la demande d’authentification
AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }
Type
{ BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }
AuthorityType
Types d’autorité pris en charge par MSAL.
AuthorityType: { Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }
Type
{ 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" }
Type
{ 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
Types de comptes dans le cache
CacheAccountType: { ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }
Type
{ ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }
CacheOutcome
Spécifie la raison de l’extraction du jeton d’accès à partir du fournisseur d’identité
CacheOutcome: { CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }
Type
{ CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }
CacheType
Combiner tous les types de cache
CacheType: { ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }
Type
{ 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" }
Type
{ HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }
ClaimsRequestKeys
Clés de demande de revendications
ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }
Type
{ ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }
CredentialType
Type d’informations d’identification stocké dans le cache
CredentialType: { ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }
Type
{ 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" }
Type
{ BASE64: "base64", HEX: "hex", UTF8: "utf-8" }
GrantType
grant_type autorisé
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" }
Type
{ 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
Noms d’en-tête de requête
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" }
Type
{ 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" }
Type
{ 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 }
Type
{ 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" }
Type
{ Jwk: "JWK", Jwt: "JWT", Pop: "pop" }
OAuthResponseType
Valeurs autorisées pour response_type
OAuthResponseType: { CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }
Type
{ CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }
PasswordGrantConstants
Paramètres d’octroi de mot de passe
PasswordGrantConstants: { password: "password", username: "username" }
Type
{ password: "password", username: "username" }
PersistentCacheKeys
Clés de cache persistantes MSAL qui restent pendant la connexion de l’utilisateur.
PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }
Type
{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }
ProtocolMode
Modes de protocole pris en charge par MSAL.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
Type
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ResponseMode
valeurs autorisées pour response_mode
ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
Type
{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
ServerResponseType
Avertissement
Cette API est à présent déconseillée.
Use ResponseMode instead
valeurs autorisées pour le type de réponse du serveur
ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }
Type
{ FRAGMENT: "fragment", QUERY: "query" }
AuthErrorMessage
Avertissement
Cette API est à présent déconseillée.
Use AuthErrorCodes instead
Classe AuthErrorMessage contenant des constantes de chaîne utilisées par les codes d’erreur et les messages.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
Type
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
ClientAuthErrorMessage
Avertissement
Cette API est à présent déconseillée.
Use ClientAuthErrorCodes instead
Constantes de chaîne utilisées par les codes d’erreur et les messages.
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 } }
Type
{ 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
Avertissement
Cette API est à présent déconseillée.
Use ClientConfigurationErrorCodes instead
Classe ClientConfigurationErrorMessage contenant des constantes de chaîne utilisées par les codes d’erreur et les messages.
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 } }
Type
{ 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
valeurs autorisées pour codeVerifier
CodeChallengeMethodValues: { PLAIN: string, S256: string }
Type
{ 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 }
Type
{ 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
Type
300
Errors
Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }
Type
{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }
IntFields
IntFields: ReadonlySet<string>
Type
ReadonlySet<string>
InteractionRequiredAuthErrorMessage
Avertissement
Cette API est à présent déconseillée.
Use InteractionRequiredAuthErrorCodes instead
Erreurs requises d’interaction définies par le Kit de développement logiciel (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 } }
Type
{ 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[]
Type
string[]
ONE_DAY_IN_MS
ONE_DAY_IN_MS: 86400000
Type
86400000
PromptValue
nous avons envisagé de rendre cette « énumération » dans la requête au lieu de chaîne, mais il semble que la liste autorisée des valeurs d’invite change au cours des deux dernières années. Il existe également des valeurs d’invite non documentées pour certains partenaires internes. Par conséquent, le choix du type générique « string » au lieu de « enum »
PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
Type
{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
StubbedNetworkModule
THE_FAMILY_ID
THE_FAMILY_ID: "1"
Type
"1"
ThrottlingConstants
Constantes liées à la limitation
ThrottlingConstants: { DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }
Type
{ 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"
Type
"15.17.0"