CustomAuthPublicClientApplication class

Crée une instance d’une Application PublicClient avec la configuration et le contrôleur donnés pour démarrer des flux d’authentification natifs

static function create(config: CustomAuthConfiguration): Promise<ICustomAuthPublicClientApplication>

Paramètres

Retours

• Promesse qui se résout en une instance CustomAuthPublicClientApplication

Obtient le compte actuel à partir du cache du navigateur.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Paramètres

Retours

• Résultat de l’opération obtenir le compte

Lance le flux de réinitialisation du mot de passe. Cette méthode entraîne le déclenchement d’une action supplémentaire (envoyer le code) pour terminer le mot de passe de réinitialisation. Créez un résultat avec des détails d’erreur si une exception levée.

function resetPassword(resetPasswordInputs: ResetPasswordInputs): Promise<ResetPasswordStartResult>

Paramètres

Retours

• Promesse qui se résout à ResetPasswordStartResult

Lance le flux de connexion. Cette méthode entraîne l’achèvement de la connexion ou des actions supplémentaires (mot de passe, code, etc.) requises pour terminer la connexion. Créez un résultat avec des détails d’erreur si une exception levée.

function signIn(signInInputs: SignInInputs): Promise<SignInResult>

Paramètres

Retours

• Promesse qui se résout à SignInResult

Lance le flux d’inscription. Cette méthode entraîne l’achèvement de l’inscription ou des actions supplémentaires (mot de passe, code, etc.) requises pour terminer l’inscription. Créez un résultat avec des détails d’erreur si une exception levée.

function signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>

Paramètres

Retours

• Promesse qui se résout à SignUpResult

Cette fonction échange un code d’autorisation (passé en tant que code) à partir du point de terminaison de jeton eSTS. Ce code d’autorisation doit être acquis côté serveur à l’aide d’un client confidentiel pour acquérir une spa_code. Cette API n’est pas indendée pour l’acquisition et l’échange de code d’autorisation normaux.

L’échange de ce code d’autorisation ne nécessite pas PKCE, car il a été acquis par un client confidentiel.

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

Paramètres

Retours

Promesse qui est remplie lorsque cette fonction est terminée ou rejetée si une erreur a été générée.

Hérité de PublicClientApplication.acquireTokenByCode

Utilisez quand vous souhaitez obtenir un access_token pour votre API via l’ouverture d’une fenêtre contextuelle dans le navigateur de l’utilisateur

function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>

Paramètres

Retours

Promesse qui est remplie lorsque cette fonction est terminée ou rejetée si une erreur a été générée.

Hérité de PublicClientApplication.acquireTokenPopup

Utilisez quand vous souhaitez obtenir une access_token pour votre API en redirigeant la fenêtre du navigateur de l’utilisateur vers le point de terminaison d’autorisation. Cette fonction redirige la page, de sorte que tout code qui suit cette fonction ne s’exécute pas.

IMPORTANT : Il n’est pas recommandé d’avoir du code dépendant de la résolution de la promesse. Cette fonction s’éloigne de la fenêtre de navigateur actuelle. Elle retourne actuellement une promesse pour refléter la nature asynchrone du code en cours d’exécution dans cette fonction.

function acquireTokenRedirect(request: RedirectRequest): Promise<void>

Paramètres

Retours

Hérité de PublicClientApplication.acquireTokenRedirect

Acquérir silencieusement un jeton d’accès pour un ensemble donné d’étendues. Retourne actuellement la promesse de traitement si des requêtes parallèles sont effectuées.

function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>

Paramètres

Retours

• une promesse qui est remplie lorsque cette fonction est terminée ou rejetée si une erreur a été générée. Renvoie l’objet AuthenticationResult

Hérité de PublicClientApplication.acquireTokenSilent

Ajoute des rappels d’événements au tableau

function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string

Paramètres

Retours

Hérité de PublicClientApplication.addEventCallback

Inscrit un rappel pour recevoir des événements de performances.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Paramètres

Retours

Hérité de PublicClientApplication.addPerformanceCallback

Efface les jetons et le compte du cache du navigateur.

function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>

Paramètres

Retours

Hérité de PublicClientApplication.clearCache

Crée StandardController et le transmet à PublicClientApplication

static function createPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Paramètres

Retours

Hérité de PublicClientApplication.createPublicClientApplication

Supprime l’écouteur d’événements qui émet un événement lorsqu’un compte d’utilisateur est ajouté ou supprimé de localstorage dans un autre onglet ou fenêtre de navigateur

function disableAccountStorageEvents()

Hérité de PublicClientApplication.disableAccountStorageEvents

Ajoute l’écouteur d’événements qui émet un événement lorsqu’un compte d’utilisateur est ajouté ou supprimé de localstorage dans un autre onglet ou fenêtre de navigateur

function enableAccountStorageEvents()

Hérité de PublicClientApplication.enableAccountStorageEvents

Retourne le premier compte trouvé dans le cache qui correspond au filtre de compte transmis.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Paramètres

Retours

Premier compte trouvé dans le cache correspondant au filtre fourni ou null si aucun compte n’est trouvé.

Hérité de PublicClientApplication.getAccount

Retourne le compte connecté correspondant à homeAccountId. (l’objet de compte est créé au moment de la connexion réussie) ou null lorsqu’aucun compte correspondant n’est trouvé

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Paramètres

Retours

Objet de compte stocké dans MSAL

Hérité de PublicClientApplication.getAccountByHomeId

Retourne le compte connecté correspondant à localAccountId. (l’objet de compte est créé au moment de la connexion réussie) ou null lorsqu’aucun compte correspondant n’est trouvé

function getAccountByLocalId(localId: string): null | AccountInfo

Paramètres

Retours

Objet de compte stocké dans MSAL

Hérité de PublicClientApplication.getAccountByLocalId

Retourne le nom d’utilisateur correspondant au compte connecté. (l’objet de compte est créé au moment de la connexion réussie) ou null lorsqu’aucun compte correspondant n’est trouvé. Cette API est fournie pour des raisons pratiques, mais getAccountById doit être utilisée pour une meilleure fiabilité

function getAccountByUsername(userName: string): null | AccountInfo

Paramètres

Retours

Objet de compte stocké dans MSAL

Hérité de PublicClientApplication.getAccountByUsername

Obtient le compte actif actuellement

function getActiveAccount(): null | AccountInfo

Retours

Hérité de PublicClientApplication.getActiveAccount

Retourne tous les comptes dans le cache qui correspondent au filtre facultatif. Si aucun filtre n’est fourni, tous les comptes sont retournés.

function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]

Paramètres

Retours

Tableau d’objets AccountInfo dans le cache

Hérité de PublicClientApplication.getAllAccounts

Retourne l’instance de l’enregistreur d’événements

function getLogger(): Logger

Retours

Hérité de PublicClientApplication.getLogger

Obtient le cache de jetons de l’application.

function getTokenCache(): ITokenCache

Retours

Hérité de PublicClientApplication.getTokenCache

Fonction de gestionnaire d’événements qui permet aux utilisateurs de déclencher des événements après le chargement de l’objet PublicClientApplication pendant les flux de redirection. Cette opération doit être appelée sur toutes les charges de page impliquées dans les flux d’authentification de redirection.

function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>

Paramètres

Retours

Réponse du jeton ou null. Si la valeur de retour est Null, aucune redirection d’authentification n’a été détectée.

Hérité de PublicClientApplication.handleRedirectPromise

Hydrate le cache avec les jetons et le compte dans l’objet AuthenticationResult

function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>

Paramètres

Retours

Hérité de PublicClientApplication.hydrateCache

Fonction Initialiseur pour effectuer des tâches de démarrage asynchrones telles que la connexion à l’extension WAM

function initialize(request?: InitializeApplicationRequest): Promise<void>

Paramètres

Retours

Hérité de PublicClientApplication.initialize

Appelée par les bibliothèques wrapper (Angular &React) pour définir la référence SKU et la version transmises à la télémétrie, à l’enregistreur d’événements, etc.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Paramètres

Hérité de PublicClientApplication.initializeWrapperLibrary

Utiliser lors du lancement du processus de connexion via l’ouverture d’une fenêtre contextuelle dans le navigateur de l’utilisateur

function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>

Paramètres

Retours

Promesse qui est remplie lorsque cette fonction est terminée ou rejetée si une erreur a été générée.

Hérité de PublicClientApplication.loginPopup

Utilisez-la lors du lancement du processus de connexion en redirigeant le navigateur de l’utilisateur vers le point de terminaison d’autorisation. Cette fonction redirige la page, de sorte que tout code qui suit cette fonction ne s’exécute pas.

IMPORTANT : Il n’est pas recommandé d’avoir du code dépendant de la résolution de la promesse. Cette fonction s’éloigne de la fenêtre de navigateur actuelle. Elle retourne actuellement une promesse pour refléter la nature asynchrone du code en cours d’exécution dans cette fonction.

function loginRedirect(request?: RedirectRequest): Promise<void>

Paramètres

Retours

Hérité de PublicClientApplication.loginRedirect

Fonction de déconnexion déconseillée. Utiliser logoutRedirect ou logoutPopup à la place

function logout(logoutRequest?: EndSessionRequest): Promise<void>

Paramètres

Retours

Hérité de PublicClientApplication.logout

Efface le cache local de l’utilisateur actuel, puis ouvre une fenêtre contextuelle invitant l’utilisateur à se déconnecter du serveur

function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>

Paramètres

Retours

Hérité de PublicClientApplication.logoutPopup

Permet de déconnecter l’utilisateur actuel et de rediriger l’utilisateur vers le postLogoutRedirectUri. Le comportement par défaut consiste à rediriger l’utilisateur vers window.location.href.

function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>

Paramètres

Retours

Hérité de PublicClientApplication.logoutRedirect

Supprime le rappel avec l’ID fourni du tableau de rappels

function removeEventCallback(callbackId: string)

Paramètres

Hérité de PublicClientApplication.removeEventCallback

Supprime un rappel inscrit avec addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Paramètres

Retours

Hérité de PublicClientApplication.removePerformanceCallback

Définit le compte à utiliser comme compte actif. Si aucun compte n’est transmis aux API acquireToken, MSAL utilise ce compte actif.

function setActiveAccount(account: null | AccountInfo)

Paramètres

Hérité de PublicClientApplication.setActiveAccount

Remplace le jeu d’événements par défaut dans les configurations par le nouvel enregistreur d’événements par de nouvelles configurations

function setLogger(logger: Logger)

Paramètres

Hérité de PublicClientApplication.setLogger

Définit le client de navigation

function setNavigationClient(navigationClient: INavigationClient)

Paramètres

Hérité de PublicClientApplication.setNavigationClient

Cette fonction utilise un iframe masqué pour extraire un code d’autorisation à partir de l’eSTS. Il existe des cas où cela peut ne pas fonctionner :

• Tout navigateur utilisant une forme de prévention intelligente du suivi
• S’il n’existe pas de session établie avec le service

Dans ces cas, la requête doit être effectuée à l’intérieur d’une redirection contextuelle ou de trame complète.

Pour les cas où l’interaction est requise, vous ne pouvez pas envoyer une demande avec prompt=none.

Si votre jeton d’actualisation a expiré, vous pouvez utiliser cette fonction pour récupérer un nouvel ensemble de jetons en mode silencieux tant que vous session sur le serveur existe toujours.

function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>

Paramètres

Retours

Promesse qui est remplie lorsque cette fonction est terminée ou rejetée si une erreur a été générée.

Hérité de PublicClientApplication.ssoSilent