@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 :

  • homeAccountId - Identificateur de compte d’accueil pour cet objet de compte
  • environnement : entité qui a émis le jeton représenté par le domaine de l’émetteur (par exemple, login.microsoftonline.com)
  • tenantId - Id de locataire complet ou d’organisation auquel appartient ce compte
  • nom d’utilisateur - preferred_username revendication du id_token qui représente ce compte
  • localAccountId - Identificateur de compte spécifique au locataire local pour cet objet de compte, généralement utilisé dans les cas hérités
  • nom - Nom complet du compte, y compris le nom donné et le nom de famille
  • idToken - jeton d’ID brut
  • idTokenClaims - L’objet contient des revendications à partir du jeton d’ID
  • nativeAccountId - ID de compte natif de l’utilisateur
  • tenantProfiles : mappage d’objets de profil de locataire pour chaque locataire avec lequel le compte s’est authentifié dans le navigateur
  • dataBoundary - Limite de données extraite de clientInfo
ActiveAccountFilters
AppMetadataEntity

Type de cache de métadonnées d’application

ApplicationTelemetry

Informations de télémétrie envoyées à la demande

  • appName : nom de chaîne unique d’une application
  • appVersion : version de l’application à l’aide de MSAL
AuthenticationResult

Résultat retourné à partir du point de terminaison de jeton de l’autorité.

  • uniqueId - oid ou sub revendication à partir d’un jeton d’ID
  • tenantId - tid revendication à partir du jeton d’ID
  • étendues : étendues validées pour le jeton respectif
  • compte : représentation d’objet de compte de l’utilisateur actuellement connecté
  • idToken - Jeton d’ID reçu dans le cadre de la réponse
  • idTokenClaims - Revendications de jeton d’ID pertinentes MSAL
  • accessToken - Jeton d’accès ou certificat SSH reçu dans le cadre de la réponse
  • fromCache - Boolean indiquant si le jeton provient du cache
  • expiresOn - Objet Date Javascript représentant l’expiration relative du jeton d’accès
  • extExpiresOn - Objet Date Javascript représentant l’expiration relative étendue du jeton d’accès en cas de panne du serveur
  • refreshOn - Objet Date Javascript représentant l’heure relative jusqu’à ce qu’un jeton d’accès soit actualisé
  • state - Valeur transmise par l’utilisateur dans la demande
  • familyId - Identificateur d’ID de famille, généralement utilisé uniquement pour les jetons d’actualisation
  • requestId - ID de requête retourné dans le cadre de la réponse
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

  • azureCloudInstance - énumération de chaîne fournissant une notation courte pour les autorités cloud publiques et soverign
  • locataire : provisionner pour fournir les informations du locataire
AzureRegion
AzureRegionConfiguration
BaseAuthRequest

BaseAuthRequest

  • autorité : URL de l’autorité, service de jeton de sécurité (STS) à partir duquel MSAL acquiert des jetons. La valeur par défaut est https://login.microsoftonline.com/common. Si vous utilisez la même autorité pour toutes les demandes, l’autorité doit être définie sur l’objet d’application cliente et non sur la requête, pour éviter de résoudre plusieurs fois les points de terminaison d’autorité.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • authenticationScheme : type de jeton récupéré. La valeur par défaut est « Porteur ». Peut également être de type « pop » ou « SSH ».
  • revendications : demande de revendications stringifiée qui sera ajoutée à tous les appels /authorize et /token
  • shrClaims - Objet de revendications stringified qui sera ajouté à une requête HTTP signée
  • shrNonce : horodatage généré par le serveur qui a été chiffré et codé en base64URL, qui sera ajouté à une requête HTTP signée.
  • shrOptions - Objet contenant des options pour la requête HTTP signée
  • resourceRequestMethod : type de requête HTTP utilisé pour demander des données à partir de la ressource (par exemple, « GET », « POST », etc.). Utilisé pour les flux de preuve de possession.
  • resourceRequestUri : URI pour lequel le jeton sera utilisé. Utilisé pour les flux de preuve de possession.
  • sshJwk : clé web JSON stringified représentant une clé publique qui peut être signée par un certificat SSH.
  • sshKid : ID de clé qui identifie de manière unique la clé publique SSH mentionnée ci-dessus.
  • azureCloudOptions - Énumérations de chaînes pratiques pour que les utilisateurs fournissent des ID de cloud public/souverain
  • requestedClaimsHash - Chaîne de hachage SHA 256 de la chaîne de revendications demandée, utilisée dans le cadre d’une clé de cache de jeton d’accès afin que les jetons puissent être filtrés par les revendications demandées
  • tokenQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /token
  • tokenBodyParameters - Chaîne à carte de chaînes des paramètres personnalisés ajoutés au corps de l’appel /token
  • storeInCache - Objet contenant des valeurs booléennes indiquant s’il faut stocker des jetons dans le cache ou non (la valeur par défaut est true)
  • scenarioId - ID de scénario pour suivre les invites d’utilisateur personnalisées
  • popKid - ID de clé pour identifier la clé publique pour la demande de jeton PoP
  • embeddedClientId - ID client incorporé. Lorsqu’ils sont spécifiés, les paramètres d’ID client broker (brk_client_id) et d’URI de redirection (brk_redirect_uri) sont définis avec des valeurs de la configuration, en remplaçant les paramètres supplémentaires correspondants, le cas échéant.
  • httpMethod : méthode HTTP à utiliser pour la requête /authorize. La valeur par défaut est GET, mais peut être définie sur POST si la requête nécessite des paramètres de corps
  • authorizePostBodyParameters - Chaîne à carte de chaînes des paramètres personnalisés ajoutés au corps de l’appel /authorize lorsque httpMethod est défini sur POST
  • skipBrokerClaims : quand la valeur est true et qu’un flux réparti est utilisé (par exemple, lorsque les analyseurs broker ou un embeddedClientId sont présents), les capacités clientCapabilities de la configuration sont exclues des revendications ; ignoré pour les flux non répartiteurs.
CacheOptions

Utilisez-le pour configurer les préférences de cache d’informations d’identification dans l’objet ClientConfiguration

  • claimsBasedCachingEnabled : définit si les jetons doivent être mis en cache en fonction du hachage des revendications. La valeur par défaut est false.
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)

  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • revendications : demande de revendications stringifiée qui sera ajoutée à tous les appels /authorize et /token
  • autorité : - URL de l’autorité, service de jeton de sécurité (STS) à partir duquel MSAL acquiert des jetons. Si l’autorité est définie sur l’objet d’application cliente, cela remplace cette valeur. La substitution de la valeur entraîne la validation de l’autorité à chaque fois. Si la même autorité sera utilisée pour toutes les requêtes, définissez sur l’objet d’application au lieu des demandes.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • redirectUri : URI de redirection de votre application, vers lequel l’autorité redirige après que l’utilisateur entre les informations d’identification et les consentements. Il doit correspondre exactement à l’une des URI de redirection que vous avez inscrits dans le portail
  • code : authorization_code que l’utilisateur a acquis dans la première étape du flux.
  • codeVerifier : la même code_verifier utilisée pour obtenir le authorization_code. Obligatoire si PKCE a été utilisé dans la demande d’octroi de code d’autorisation. Pour plus d’informations, consultez le RFC PKCE : https://tools.ietf.org/html/rfc7636
  • resourceRequestMethod : type de requête HTTP utilisé pour demander des données à partir de la ressource (par exemple, « GET », « POST », etc.). Utilisé pour les flux de preuve de possession.
  • resourceRequestUri : URI pour lequel le jeton sera utilisé. Utilisé pour les flux de preuve de possession.
  • enableSpaAuthCode - Active l’acqusition d’un code d’autorisation spa (clients confidentiels uniquement)
  • tokenQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /token
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)

  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • revendications : demande de revendications stringifiée qui sera ajoutée à tous les appels /authorize et /token
  • autorité : URL de l’autorité à partir de laquelle l’application acquiert des jetons.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • redirectUri : URI de redirection où les réponses d’authentification peuvent être reçues par votre application. Il doit correspondre exactement à l’une des URI de redirection inscrits dans le portail Azure.
  • extraScopesToConsent : étendues pour une autre ressource lorsque l’utilisateur a besoin d’un consentement initial.
  • responseMode : spécifie la méthode qui doit être utilisée pour envoyer le résultat d’authentification à votre application. Peut être une requête, form_post ou un fragment. Si aucune valeur n’est transmise, elle effectue par défaut une requête.
  • codeChallenge : utilisé pour sécuriser l’octroi de code d’autorisation via la preuve de clé pour le code Exchange (PKCE). Pour plus d’informations, consultez le RCF PKCE :https://tools.ietf.org/html/rfc7636
  • codeChallengeMethod : méthode utilisée pour encoder le vérificateur de code pour le paramètre de défi de code. Peut être « brut » ou « S256 ». Si elle est exclue, le défi de code est supposé être en texte clair. Pour plus d’informations, consultez le RCF PKCE : https://tools.ietf.org/html/rfc7636
  • state : valeur incluse dans la requête qui est également retournée dans la réponse du jeton. Une valeur unique générée de manière aléatoire est généralement utilisée pour empêcher les attaques de falsification de requête intersites. L’état est également utilisé pour encoder des informations sur l’état de l’utilisateur dans l’application avant la demande d’authentification.
  • invite : indique le type d’interaction utilisateur requis. connexion : force l’utilisateur à entrer ses informations d’identification sur cette demande, négation de l’authentification unique aucun : vérifie que l’utilisateur n’est pas présenté avec une invite interactive. si la demande ne peut pas être effectuée via l’authentification unique, le point de terminaison renvoie un consentement d’erreur interaction_required : déclenche la boîte de dialogue de consentement OAuth une fois l’utilisateur connecté, demandant à l’utilisateur d’accorder des autorisations à l’application select_account : interrompt l’authentification unique pour fournir une expérience de sélection de compte qui répertorie tous les comptes dans la session ou tout compte mémorisé ou une option permettant d’utiliser une autre création de compte : dirigera l’utilisateur vers l’expérience de création de compte au lieu de l’expérience de connexion no_session : ne lit pas le jeton de session existant lors de l’authentification de l’utilisateur. Une fois l’utilisateur authentifié, EVO ne crée pas de session pour l’utilisateur. À USAGE INTERNE UNIQUEMENT.
  • account - AccountInfo obtenu à partir d’une API getAccount. Sera utilisé dans certains scénarios pour générer des login_hint si les paramètres loginHint et Sid ne sont pas fournis.
  • loginHint : peut être utilisé pour pré-remplir le champ nom d’utilisateur/adresse e-mail de la page de connexion de l’utilisateur, si vous connaissez l’adresse nom d’utilisateur/e-mail à l’avance. Souvent, les applications utilisent ce paramètre pendant la réauthentification, ayant déjà extrait le nom d’utilisateur d’une connexion précédente à l’aide de la revendication preferred_username.
  • sid - ID de session, identificateur unique pour la session. Disponible en tant que revendication facultative sur les jetons d’ID.
  • domainHint : fournit un indicateur sur le locataire ou le domaine que l’utilisateur doit utiliser pour se connecter. La valeur de l’indicateur de domaine est un domaine inscrit pour le locataire.
  • extraQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /authorize
  • tokenQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /token
  • nonce : valeur incluse dans la requête retournée dans le jeton d’ID. Une valeur unique générée de manière aléatoire est généralement utilisée pour atténuer les attaques par relecture.
  • resourceRequestMethod : type de requête HTTP utilisé pour demander des données à partir de la ressource (par exemple, « GET », « POST », etc.). Utilisé pour les flux de preuve de possession.
  • resourceRequestUri : URI pour lequel le jeton sera utilisé. Utilisé pour les flux de preuve de possession.
CommonEndSessionRequest

CommonEndSessionRequest

  • account - Objet account qui sera déconnecté. Tous les jetons liés à ce compte sont effacés.
  • postLogoutRedirectUri - URI vers lequel accéder après la page de déconnexion.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • idTokenHint - Jeton d’ID utilisé par B2C pour valider la déconnexion si nécessaire par la stratégie
  • état : valeur incluse dans la requête au point de terminaison de déconnexion qui sera retournée dans la chaîne de requête lors de la redirection post-déconnexion
  • logoutHint : chaîne qui spécifie le compte qui est déconnecté afin d’ignorer le sélecteur de compte de serveur lors de la déconnexion
  • extraQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /authorize
CommonRefreshTokenRequest

CommonRefreshTokenRequest

  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • revendications : demande de revendications stringifiée qui sera ajoutée à tous les appels /authorize et /token
  • autorité : URL de l’autorité, service de jeton de sécurité (STS) à partir duquel MSAL acquiert des jetons.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • refreshToken : jeton d’actualisation retourné par une demande précédente au fournisseur d’identité.
  • resourceRequestMethod : type de requête HTTP utilisé pour demander des données à partir de la ressource (par exemple, « GET », « POST », etc.). Utilisé pour les flux de preuve de possession.
  • resourceRequestUri : URI pour lequel le jeton sera utilisé. Utilisé pour les flux de preuve de possession.
  • forceCache - Forcer MSAL à mettre en cache une réponse de flux de jeton d’actualisation lorsqu’il n’existe aucun compte dans le cache. Utilisé pour les scénarios de migration.
  • tokenQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /token
CommonSilentFlowRequest

Paramètres SilentFlow transmis par l’utilisateur pour récupérer les informations d’identification en mode silencieux

  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • revendications : demande de revendications stringifiée qui sera ajoutée à tous les appels /authorize et /token. Lorsqu’elle est incluse dans une demande silencieuse, la recherche du cache est ignorée et le jeton est actualisé.
  • autorité : URL de l’autorité à partir de laquelle l’application acquiert des jetons.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • compte : entité de compte pour rechercher les informations d’identification.
  • forceRefresh : force les requêtes silencieuses à effectuer des appels réseau si la valeur est true.
  • resourceRequestMethod : type de requête HTTP utilisé pour demander des données à partir de la ressource (par exemple, « GET », « POST », etc.). Utilisé pour les flux de preuve de possession.
  • resourceRequestUri : URI pour lequel le jeton sera utilisé. Utilisé pour les flux de preuve de possession.
  • tokenQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /token
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.

  • token_type : indique la valeur du type de jeton. Le seul type pris en charge par AZURE AD est Bearer.
  • étendue : étendues pour laquelle le access_token est valide.
  • expires_in : durée pendant laquelle le jeton d’accès est valide (en secondes).
  • id_token : jeton web JSON (JWT). L’application peut décoder les segments de ce jeton pour demander des informations sur l’utilisateur qui s’est connecté.
  • refresh_token : jeton d’actualisation OAuth 2.0. L’application peut utiliser ce jeton pour acquérir des jetons d’accès supplémentaires après l’expiration du jeton d’accès actuel.
  • access_token : jeton d’accès demandé. L’application peut utiliser ce jeton pour s’authentifier auprès de la ressource sécurisée, telle qu’une API web.
  • client_info : objet d’informations client
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 :

  • ID : identificateur unique pour cette requête
  • ts : horodatage pour l’heure à laquelle la requête a été effectuée. Permet de s’assurer que l’expiration du jeton n’est pas calculée de manière incorrecte.
  • platformState : valeur de chaîne envoyée à partir de la plateforme.
LoggerOptions

Utilisez-le pour configurer la journalisation que MSAL effectue, en configurant les options d’enregistreur d’événements dans l’objet Configuration

  • loggerCallback - Rappel pour l’enregistreur d’événements
  • piiLoggingEnabled : définit si la journalisation pii est activée
  • logLevel : définit le niveau auquel la journalisation se produit
  • correlationId : définit l’ID de corrélation imprimé par l’enregistreur d’événements
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.

  • token_type : indique la valeur du type de jeton. Peut être porteur ou pop.
  • étendue : étendues pour laquelle le access_token est valide.
  • expires_in : durée pendant laquelle le jeton d’accès est valide (en secondes).
  • refresh_in : durée de renouvellement d’un jeton, quel que soit l’expiration.
  • ext_expires_in : durée pendant laquelle le jeton d’accès est valide (en secondes) si le serveur ne répond pas.
  • access_token : jeton d’accès demandé. L’application peut utiliser ce jeton pour s’authentifier auprès de la ressource sécurisée, telle qu’une API web.
  • refresh_token : jeton d’actualisation OAuth 2.0. L’application peut utiliser ce jeton pour acquérir des jetons d’accès supplémentaires après l’expiration du jeton d’accès actuel.
  • id_token : jeton web JSON (JWT). L’application peut décoder les segments de ce jeton pour demander des informations sur l’utilisateur qui s’est connecté.
  • key_id : chaîne qui identifie de manière unique une clé publique à laquelle la requête est liée.

En cas d’erreur :

  • erreur : chaîne de code d’erreur qui peut être utilisée pour classer les types d’erreurs qui se produisent et qui peuvent être utilisés pour réagir aux erreurs.
  • error_description : message d’erreur spécifique qui peut aider un développeur à identifier la cause racine d’une erreur d’authentification.
  • error_codes : liste des codes d’erreur propres à STS qui peuvent vous aider dans les diagnostics.
  • timestamp : heure à laquelle l’erreur s’est produite.
  • trace_id : identificateur unique de la demande qui peut vous aider dans les diagnostics.
  • correlation_id : identificateur unique de la demande qui peut vous aider dans les diagnostics entre les composants.
  • état : état de la réponse de la demande réseau
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

  • tokenRenewalOffsetSeconds : définit la fenêtre de décalage nécessaire pour renouveler le jeton avant l’expiration
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.

  • correlationId : ID de corrélation associé à la requête
  • tenantId : ID de locataire pour lequel le jeton doit être fourni
  • étendues : étendues pour lesquelles le jeton doit être fourni
  • revendications : toutes les revendications supplémentaires que le jeton doit satisfaire
AppTokenProviderResult

Objet output pour IAppTokenProvider extensiblity.

  • accessToken : jeton d’accès réel, généralement au format JWT, qui satisfait aux données de requête AppTokenProviderParameters
  • expiresInSeconds : durée pendant laquelle les jetons ont avant l’expiration, en secondes. Similaire au champ « expires_in » dans une réponse de jeton AAD.
  • refreshInSeconds : durée pendant laquelle le jeton doit être actualisé de manière proactive. Similaire au champ « refresh_in » dans une réponse de jeton AAD.
ClientAssertion

Informations d’identification d’assertion du client pour les clients confidentiels

ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest

CommonClientCredentialRequest

  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • autorité : URL de l’autorité, service de jeton de sécurité (STS) à partir duquel MSAL acquiert des jetons.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • skipCache : ignorez la recherche du cache de jetons et forcez la demande à l’autorité pour obtenir un nouveau jeton. La valeur par défaut est false.
  • preferredAzureRegionOptions - Options de la région Azure préférée de l’utilisateur
  • tokenQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /token
CommonDeviceCodeRequest

Paramètres du flux de code d’appareil Oauth2.

  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • autorité : - URL de l’autorité, service de jeton de sécurité (STS) à partir duquel MSAL acquiert des jetons. Si l’autorité est définie sur l’objet d’application cliente, cela remplace cette valeur. La substitution de la valeur entraîne la validation de l’autorité à chaque fois. Si la même autorité sera utilisée pour toutes les requêtes, définissez sur l’objet d’application au lieu des demandes.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • deviceCodeCallback : rappel contenant la réponse du code d’appareil. Le message doit être affiché à l’utilisateur final. L’utilisateur final peut ensuite accéder au verification_uri, entrer le user_code et les informations d’identification d’entrée.
  • cancel : booléen pour annuler l’interrogation du point de terminaison de code de l’appareil. Bien que l’utilisateur s’authentifie sur un appareil distinct, MSAL interroge le point de terminaison de jeton du service de jeton de sécurité pour l’intervalle spécifié dans la réponse du code de l’appareil (généralement 15 minutes). Pour arrêter l’interrogation et annuler la requête, définissez cancel=true.
  • resourceRequestMethod : type de requête HTTP utilisé pour demander des données à partir de la ressource (par exemple, « GET », « POST », etc.). Utilisé pour les flux de preuve de possession.
  • resourceRequestUri : URI pour lequel le jeton sera utilisé. Utilisé pour les flux de preuve de possession.
  • délai d’expiration : période d’expiration en secondes que l’utilisateur configure explicitement pour l’interrogation du point de terminaison de code de l’appareil. À la fin de cette période ; en supposant que le code de l’appareil n’a pas encore expiré ; l’interrogation du code de l’appareil est arrêtée et la demande a été annulée. La fenêtre d’expiration du code d’appareil est toujours prioritaire sur cette période définie.
  • extraQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à la chaîne de requête
CommonOnBehalfOfRequest
  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • autorité : URL de l’autorité, service de jeton de sécurité (STS) à partir duquel MSAL acquiert des jetons.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • oboAssertion : jeton d’accès envoyé à l’API de niveau intermédiaire. Ce jeton doit avoir un public de l’application qui effectue cette requête OBO.
  • skipCache : ignorez la recherche du cache de jetons et forcez la demande à l’autorité pour obtenir un nouveau jeton. La valeur par défaut est false.
  • tokenQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /token
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.

  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • revendications : demande de revendications stringifiée qui sera ajoutée à tous les appels /authorize et /token. Lorsqu’elle est incluse dans une demande silencieuse, la recherche du cache est ignorée et le jeton est actualisé.
  • autorité : URL de l’autorité à partir de laquelle l’application acquiert des jetons.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • nom d’utilisateur - nom d’utilisateur du client
  • mot de passe - informations d’identification
  • tokenQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à l’appel /token
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.

  • userCode : code que l’utilisateur doit fournir lors de l’authentification à l’URI de vérification
  • deviceCode : code qui doit être inclus dans la demande de jeton d’accès
  • verificationUri : URI où l’utilisateur peut s’authentifier
  • expireIn : délai d’expiration du code de l’appareil en secondes
  • intervalle : intervalle auquel le STS doit être interrogé à
  • message : message qui doit être affiché à l’utilisateur
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

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

Fonction pour générer un objet d’informations client à partir de la chaîne clientInfo du serveur

buildClientInfoFromHomeAccountId(string)

Fonction pour générer un objet d’informations client à partir de la chaîne homeAccountId mise en cache

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

Générer un profil de locataire

createAuthError(string, string)
createCacheError(unknown)

Fonction d’assistance pour encapsuler les erreurs de navigateur dans un objet CacheError

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

Crée une interactionRequiredAuthError

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

Crée un objet NetworkError pour une requête réseau ayant échoué

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

Obtient tenantId à partir des revendications de jeton d’ID disponibles à définir comme domaine d’informations d’identification avec la priorité suivante :

  1. tid : si le jeton est acquis à partir d’un locataire AZURE AD tid sera présent
  2. tfp : si le jeton est acquis à partir d’une tfp de locataire B2C moderne doit être présent
  3. 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
tenantIdMatchesHomeTenant(string, string)

Retourne true si tenantId correspond à la partie utid de homeAccountId

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

Variables

AADAuthorityConstants

Constantes de chaîne liées à l’autorité AAD

AuthenticationScheme

Type de la demande d’authentification

AuthorityType

Types d’autorité pris en charge par MSAL.

AzureCloudInstance
CacheAccountType

Types de comptes dans le cache

CacheOutcome

Spécifie la raison de l’extraction du jeton d’accès à partir du fournisseur d’identité

CacheType

Combiner tous les types de cache

CcsCredentialType
ClaimsRequestKeys

Clés de demande de revendications

CredentialType

Type d’informations d’identification stocké dans le cache

EncodingTypes
GrantType

grant_type autorisé

HeaderNames

Noms d’en-tête de requête

HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType

Valeurs autorisées pour response_type

PasswordGrantConstants

Paramètres d’octroi de mot de passe

PersistentCacheKeys

Clés de cache persistantes MSAL qui restent pendant la connexion de l’utilisateur.

ProtocolMode

Modes de protocole pris en charge par MSAL.

ResponseMode

valeurs autorisées pour response_mode

ServerResponseType

valeurs autorisées pour le type de réponse du serveur

AuthErrorMessage

Classe AuthErrorMessage contenant des constantes de chaîne utilisées par les codes d’erreur et les messages.

ClientAuthErrorMessage

Constantes de chaîne utilisées par les codes d’erreur et les messages.

ClientConfigurationErrorMessage

Classe ClientConfigurationErrorMessage contenant des constantes de chaîne utilisées par les codes d’erreur et les messages.

CodeChallengeMethodValues

valeurs autorisées pour codeVerifier

Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage

Erreurs requises d’interaction définies par le Kit de développement logiciel (SDK)

OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
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 »

StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants

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 :

  1. tid : si le jeton est acquis à partir d’un locataire AZURE AD tid sera présent
  2. tfp : si le jeton est acquis à partir d’une tfp de locataire B2C moderne doit être présent
  3. 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_CRYPTO_IMPLEMENTATION: ICrypto

Type

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Type

Required<SystemOptions>

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

StubbedNetworkModule: INetworkModule

Type

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"