CustomAuthPublicClientApplication class

Crea una nuova istanza di PublicClientApplication con la configurazione e il controller specificati per avviare flussi di autenticazione nativi

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

Parametri

Valori restituiti

• Promessa che viene risolta in un'istanza customAuthPublicClientApplication

Ottiene l'account corrente dalla cache del browser.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parametri

Valori restituiti

• Risultato dell'operazione get account

Avvia il flusso di reimpostazione della password. Questo metodo comporta l'attivazione di un'azione aggiuntiva (invia codice) per completare la password di reimpostazione. Creare il risultato con i dettagli dell'errore se viene generata un'eccezione.

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

Parametri

Valori restituiti

• Promessa che si risolve in ResetPasswordStartResult

Avvia il flusso di accesso. Questo metodo comporta il completamento dell'accesso o azioni aggiuntive (password, codice e così via) necessarie per completare l'accesso. Creare il risultato con i dettagli dell'errore se viene generata un'eccezione.

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

Parametri

Valori restituiti

• Promessa che si risolve in SignInResult

Avvia il flusso di iscrizione. Questo metodo comporta il completamento dell'iscrizione o azioni aggiuntive (password, codice e così via) necessarie per completare l'iscrizione. Creare il risultato con i dettagli dell'errore se viene generata un'eccezione.

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

Parametri

Valori restituiti

• Promessa che si risolve in SignUpResult

Questa funzione riscatta un codice di autorizzazione (passato come codice) dall'endpoint del token eSTS. Questo codice di autorizzazione deve essere acquisito sul lato server usando un client riservato per acquisire un spa_code. Questa API non viene inserita per l'acquisizione e il riscatto normali del codice di autorizzazione.

Il riscatto di questo codice di autorizzazione non richiederà PKCE, perché è stato acquisito da un client riservato.

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

Parametri

Valori restituiti

Promessa che viene soddisfatta quando questa funzione è stata completata o rifiutata se è stato generato un errore.

Ereditato da PublicClientApplication.acquireTokenByCode

Usare quando si vuole ottenere un access_token per l'API aprendo una finestra popup nel browser dell'utente

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

Parametri

Valori restituiti

Promessa che viene soddisfatta quando questa funzione è stata completata o rifiutata se è stato generato un errore.

Ereditato da PublicClientApplication.acquireTokenPopup

Usare quando si vuole ottenere un access_token per l'API reindirizzando la finestra del browser dell'utente all'endpoint di autorizzazione. Questa funzione reindirizza la pagina, quindi qualsiasi codice che segue questa funzione non verrà eseguito.

IMPORTANTE: non è consigliabile disporre di codice dipendente dalla risoluzione della promessa. Questa funzione si allontana dalla finestra del browser corrente. Attualmente restituisce una promessa per riflettere la natura asincrona del codice in esecuzione in questa funzione.

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.acquireTokenRedirect

Acquisire automaticamente un token di accesso per un determinato set di ambiti. Restituisce la promessa di elaborazione se vengono effettuate richieste parallele.

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

Parametri

Valori restituiti

• una promessa che viene soddisfatta quando questa funzione è stata completata o rifiutata se è stato generato un errore. Restituisce l'oggetto AuthenticationResult

Ereditato da PublicClientApplication.acquireTokenSilent

Aggiunge callback di eventi alla matrice

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.addEventCallback

Registra un callback per ricevere eventi di prestazioni.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametri

Valori restituiti

Ereditato da PublicClientApplication.addPerformanceCallback

Cancella i token e l'account dalla cache del browser.

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.clearCache

Crea StandardController e lo passa a PublicClientApplication

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.createPublicClientApplication

Rimuove il listener di eventi che genera un evento quando un account utente viene aggiunto o rimosso da localstorage in un'altra scheda o finestra del browser

function disableAccountStorageEvents()

Ereditato da PublicClientApplication.disableAccountStorageEvents

Aggiunge un listener di eventi che genera un evento quando un account utente viene aggiunto o rimosso da localstorage in un'altra scheda o finestra del browser

function enableAccountStorageEvents()

Ereditato da PublicClientApplication.enableAccountStorageEvents

Restituisce il primo account trovato nella cache che corrisponde al filtro dell'account passato.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parametri

Valori restituiti

Il primo account trovato nella cache corrispondente al filtro specificato o null se non è stato trovato alcun account.

Ereditato da PublicClientApplication.getAccount

Restituisce l'account connesso corrispondente a homeAccountId. (l'oggetto account viene creato al momento dell'accesso riuscito) o null quando non viene trovato alcun account corrispondente

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parametri

Valori restituiti

Oggetto account archiviato in MSAL

Ereditato da PublicClientApplication.getAccountByHomeId

Restituisce l'account connesso corrispondente a localAccountId. (l'oggetto account viene creato al momento dell'accesso riuscito) o null quando non viene trovato alcun account corrispondente

function getAccountByLocalId(localId: string): null | AccountInfo

Parametri

Valori restituiti

Oggetto account archiviato in MSAL

Ereditato da PublicClientApplication.getAccountByLocalId

Restituisce il nome utente corrispondente all'account connesso. (l'oggetto account viene creato al momento dell'accesso riuscito) o null quando non viene trovato alcun account corrispondente. Questa API viene fornita per praticità, ma getAccountById deve essere usata per garantire un'affidabilità ottimale

function getAccountByUsername(userName: string): null | AccountInfo

Parametri

Valori restituiti

Oggetto account archiviato in MSAL

Ereditato da PublicClientApplication.getAccountByUsername

Ottiene l'account attualmente attivo

function getActiveAccount(): null | AccountInfo

Valori restituiti

Ereditato da PublicClientApplication.getActiveAccount

Restituisce tutti gli account nella cache che corrispondono al filtro facoltativo. Se non viene specificato alcun filtro, vengono restituiti tutti gli account.

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

Parametri

Valori restituiti

Matrice di oggetti AccountInfo nella cache

Ereditato da PublicClientApplication.getAllAccounts

Restituisce l'istanza del logger

function getLogger(): Logger

Valori restituiti

Ereditato da PublicClientApplication.getLogger

Ottiene la cache dei token per l'applicazione.

function getTokenCache(): ITokenCache

Valori restituiti

Ereditato da PublicClientApplication.getTokenCache

Funzione del gestore eventi che consente agli utenti di generare eventi dopo il caricamento dell'oggetto PublicClientApplication durante i flussi di reindirizzamento. Questa operazione deve essere richiamata in tutti i caricamenti di pagina coinvolti nei flussi di autenticazione di reindirizzamento.

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

Parametri

Valori restituiti

Risposta del token o null. Se il valore restituito è Null, non è stato rilevato alcun reindirizzamento dell'autenticazione.

Ereditato da PublicClientApplication.handleRedirectPromise

Idrata la cache con i token e l'account nell'oggetto AuthenticationResult

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.hydrateCache

Funzione di inizializzatore per eseguire attività di avvio asincrone, ad esempio la connessione all'estensione WAM

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.initialize

Chiamato dalle librerie wrapper (Angular & React) per impostare SKU e versione passati ai dati di telemetria, al logger e così via.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parametri

Ereditato da PublicClientApplication.initializeWrapperLibrary

Usare quando si avvia il processo di accesso tramite l'apertura di una finestra popup nel browser dell'utente

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

Parametri

Valori restituiti

Promessa che viene soddisfatta quando questa funzione è stata completata o rifiutata se è stato generato un errore.

Ereditato da PublicClientApplication.loginPopup

Usare quando si avvia il processo di accesso reindirizzando il browser dell'utente all'endpoint di autorizzazione. Questa funzione reindirizza la pagina, quindi qualsiasi codice che segue questa funzione non verrà eseguito.

IMPORTANTE: non è consigliabile disporre di codice dipendente dalla risoluzione della promessa. Questa funzione si allontana dalla finestra del browser corrente. Attualmente restituisce una promessa per riflettere la natura asincrona del codice in esecuzione in questa funzione.

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.loginRedirect

Funzione di disconnessione deprecata. Usare logoutRedirect o logoutPopup

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.logout

Cancella la cache locale per l'utente corrente e quindi apre una finestra popup che richiede all'utente di disconnettersi dal server

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.logoutPopup

Usare per disconnettere l'utente corrente e reindirizzare l'utente al postLogoutRedirectUri. Il comportamento predefinito consiste nel reindirizzare l'utente a window.location.href.

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

Parametri

Valori restituiti

Ereditato da PublicClientApplication.logoutRedirect

Rimuove il callback con l'ID specificato dalla matrice di callback

function removeEventCallback(callbackId: string)

Parametri

Ereditato da PublicClientApplication.removeEventCallback

Rimuove un callback registrato con addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametri

Valori restituiti

Ereditato da PublicClientApplication.removePerformanceCallback

Imposta l'account da usare come account attivo. Se non viene passato alcun account alle API acquireToken, MSAL userà questo account attivo.

function setActiveAccount(account: null | AccountInfo)

Parametri

Ereditato da PublicClientApplication.setActiveAccount

Sostituisce il logger predefinito impostato nelle configurazioni con il nuovo Logger con nuove configurazioni

function setLogger(logger: Logger)

Parametri

Ereditato da PublicClientApplication.setLogger

Imposta il client di navigazione

function setNavigationClient(navigationClient: INavigationClient)

Parametri

Ereditato da PublicClientApplication.setNavigationClient

Questa funzione usa un iframe nascosto per recuperare un codice di autorizzazione dall'eSTS. In alcuni casi ciò potrebbe non funzionare:

• Qualsiasi browser che usa una forma di prevenzione del rilevamento intelligente
• Se non è presente una sessione stabilita con il servizio

In questi casi, la richiesta deve essere eseguita all'interno di un reindirizzamento popup o full frame.

Per i casi in cui è necessaria l'interazione, non è possibile inviare una richiesta con prompt=none.

Se il token di aggiornamento è scaduto, è possibile usare questa funzione per recuperare automaticamente un nuovo set di token, purché la sessione nel server esista ancora.

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

Parametri

Valori restituiti

Promessa che viene soddisfatta quando questa funzione è stata completata o rifiutata se è stato generato un errore.

Ereditato da PublicClientApplication.ssoSilent