CustomAuthPublicClientApplication class

Crea una nueva instancia de publicClientApplication con la configuración y el controlador especificados para iniciar flujos de autenticación nativos.

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

Parámetros

Devoluciones

• Promesa que se resuelve en una instancia de CustomAuthPublicClientApplication

Obtiene la cuenta actual de la caché del explorador.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parámetros

Devoluciones

• Resultado de la operación get account

Inicia el flujo de restablecimiento de contraseña. Este método provoca que se desencadene una acción adicional (enviar código) para completar la contraseña de restablecimiento. Cree el resultado con detalles de error si se produce alguna excepción.

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

Parámetros

Devoluciones

• Promesa que se resuelve en ResetPasswordStartResult

Inicia el flujo de inicio de sesión. Este método da como resultado la finalización del inicio de sesión o acciones adicionales (contraseña, código, etc.) necesarias para completar el inicio de sesión. Cree el resultado con detalles de error si se produce alguna excepción.

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

Parámetros

Devoluciones

• Promesa que se resuelve en SignInResult

Inicia el flujo de registro. Este método da como resultado la finalización del registro o acciones adicionales (contraseña, código, etc.) necesarias para completar el registro. Cree el resultado con detalles de error si se produce alguna excepción.

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

Parámetros

Devoluciones

• Promesa que se resuelve en SignUpResult

Esta función canjea un código de autorización (pasado como código) desde el punto de conexión del token de eSTS. Este código de autorización debe adquirirse en el lado servidor mediante un cliente confidencial para adquirir un spa_code. Esta API no está codificada para la adquisición y el canje normales del código de autorización.

El canje de este código de autorización no requerirá PKCE, ya que lo adquirió un cliente confidencial.

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

Parámetros

Devoluciones

Promesa que se cumple cuando se ha completado esta función o se rechaza si se ha generado un error.

Heredado de PublicClientApplication.acquireTokenByCode

Use cuando desee obtener una access_token para la API mediante la apertura de una ventana emergente en el explorador del usuario.

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

Parámetros

Devoluciones

Promesa que se cumple cuando se ha completado esta función o se rechaza si se ha generado un error.

Heredado de PublicClientApplication.acquireTokenPopup

Use cuando desee obtener una access_token para la API redirigiendo la ventana del explorador del usuario al punto de conexión de autorización. Esta función redirige la página, por lo que cualquier código que siga a esta función no se ejecutará.

IMPORTANTE: NO se recomienda tener código que dependa de la resolución de la promesa. Esta función se alejará de la ventana actual del explorador. Actualmente devuelve una promesa para reflejar la naturaleza asincrónica del código que se ejecuta en esta función.

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.acquireTokenRedirect

Adquirir de forma silenciosa un token de acceso para un conjunto determinado de ámbitos. Devuelve la promesa de procesamiento actual si se realizan solicitudes paralelas.

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

Parámetros

Devoluciones

• una promesa que se cumple cuando se ha completado esta función o se rechaza si se ha generado un error. Devuelve el AuthenticationResult objeto .

Heredado de PublicClientApplication.acquireTokenSilent

Agrega devoluciones de llamada de eventos a la matriz

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.addEventCallback

Registra una devolución de llamada para recibir eventos de rendimiento.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parámetros

Devoluciones

Heredado de PublicClientApplication.addPerformanceCallback

Borra los tokens y la cuenta de la caché del explorador.

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.clearCache

Crea StandardController y lo pasa a PublicClientApplication.

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.createPublicClientApplication

Quita el agente de escucha de eventos que emite un evento cuando se agrega o quita una cuenta de usuario de localstorage en otra pestaña o ventana del explorador.

function disableAccountStorageEvents()

Heredado de PublicClientApplication.disableAccountStorageEvents

Agrega un agente de escucha de eventos que emite un evento cuando se agrega o quita una cuenta de usuario de localstorage en otra pestaña o ventana del explorador.

function enableAccountStorageEvents()

Heredado de PublicClientApplication.enableAccountStorageEvents

Devuelve la primera cuenta que se encuentra en la memoria caché que coincide con el filtro de cuenta pasado.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parámetros

Devoluciones

La primera cuenta que se encuentra en la memoria caché que coincide con el filtro proporcionado o null si no se encuentra ninguna cuenta.

Heredado de PublicClientApplication.getAccount

Devuelve la cuenta con sesión iniciada que coincide con homeAccountId. (el objeto account se crea en el momento del inicio de sesión correcto) o null cuando no se encuentra ninguna cuenta coincidente.

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parámetros

Devoluciones

Objeto de cuenta almacenado en MSAL

Heredado de PublicClientApplication.getAccountByHomeId

Devuelve la cuenta con sesión iniciada que coincide con localAccountId. (el objeto account se crea en el momento del inicio de sesión correcto) o null cuando no se encuentra ninguna cuenta coincidente.

function getAccountByLocalId(localId: string): null | AccountInfo

Parámetros

Devoluciones

Objeto de cuenta almacenado en MSAL

Heredado de PublicClientApplication.getAccountByLocalId

Devuelve el nombre de usuario que coincide con la cuenta con sesión iniciada. (el objeto de cuenta se crea en el momento del inicio de sesión correcto) o null cuando no se encuentra ninguna cuenta coincidente. Esta API se proporciona para mayor comodidad, pero getAccountById debe usarse para mejorar la confiabilidad.

function getAccountByUsername(userName: string): null | AccountInfo

Parámetros

Devoluciones

Objeto de cuenta almacenado en MSAL

Heredado de PublicClientApplication.getAccountByUsername

Obtiene la cuenta activa actualmente.

function getActiveAccount(): null | AccountInfo

Devoluciones

Heredado de PublicClientApplication.getActiveAccount

Devuelve todas las cuentas de la memoria caché que coinciden con el filtro opcional. Si no se proporciona ningún filtro, se devuelven todas las cuentas.

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

Parámetros

Devoluciones

Matriz de objetos AccountInfo en la memoria caché

Heredado de PublicClientApplication.getAllAccounts

Devuelve la instancia del registrador.

function getLogger(): Logger

Devoluciones

Heredado de PublicClientApplication.getLogger

Obtiene la caché de tokens de la aplicación.

function getTokenCache(): ITokenCache

Devoluciones

Heredado de PublicClientApplication.getTokenCache

Función del controlador de eventos que permite a los usuarios desencadenar eventos después de que el objeto PublicClientApplication se haya cargado durante los flujos de redirección. Se debe invocar en todas las cargas de página implicadas en los flujos de autenticación de redirección.

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

Parámetros

Devoluciones

Respuesta de token o null. Si el valor devuelto es NULL, no se detectó ninguna redirección de autenticación.

Heredado de PublicClientApplication.handleRedirectPromise

Hidrata la memoria caché con los tokens y la cuenta en el objeto AuthenticationResult

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.hydrateCache

Función de inicializador para realizar tareas de inicio asincrónicas, como la conexión a la extensión WAM

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.initialize

Llamado por bibliotecas contenedoras (Angular & React) para establecer la SKU y la versión que se pasan a telemetría, registrador, etc.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parámetros

Heredado de PublicClientApplication.initializeWrapperLibrary

Use al iniciar el proceso de inicio de sesión mediante la apertura de una ventana emergente en el explorador del usuario.

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

Parámetros

Devoluciones

Promesa que se cumple cuando se ha completado esta función o se rechaza si se ha generado un error.

Heredado de PublicClientApplication.loginPopup

Use al iniciar el proceso de inicio de sesión redirigiendo el explorador del usuario al punto de conexión de autorización. Esta función redirige la página, por lo que cualquier código que siga a esta función no se ejecutará.

IMPORTANTE: NO se recomienda tener código que dependa de la resolución de la promesa. Esta función se alejará de la ventana actual del explorador. Actualmente devuelve una promesa para reflejar la naturaleza asincrónica del código que se ejecuta en esta función.

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.loginRedirect

Función de cierre de sesión en desuso. Use logoutRedirect o logoutPopup en su lugar.

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.logout

Borra la caché local del usuario actual y, a continuación, abre una ventana emergente que solicita al usuario que cierre la sesión del servidor.

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.logoutPopup

Use para cerrar la sesión del usuario actual y redirigir al usuario a postLogoutRedirectUri. El comportamiento predeterminado es redirigir al usuario a window.location.href.

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

Parámetros

Devoluciones

Heredado de PublicClientApplication.logoutRedirect

Quita la devolución de llamada con el identificador proporcionado de la matriz de devolución de llamada.

function removeEventCallback(callbackId: string)

Parámetros

Heredado de PublicClientApplication.removeEventCallback

Quita una devolución de llamada registrada con addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parámetros

Devoluciones

Heredado de PublicClientApplication.removePerformanceCallback

Establece la cuenta que se va a usar como cuenta activa. Si no se pasa ninguna cuenta a las API acquireToken, MSAL usará esta cuenta activa.

function setActiveAccount(account: null | AccountInfo)

Parámetros

Heredado de PublicClientApplication.setActiveAccount

Reemplaza el registrador predeterminado establecido en configuraciones por el nuevo registrador por nuevas configuraciones.

function setLogger(logger: Logger)

Parámetros

Heredado de PublicClientApplication.setLogger

Establece el cliente de navegación

function setNavigationClient(navigationClient: INavigationClient)

Parámetros

Heredado de PublicClientApplication.setNavigationClient

Esta función usa un iframe oculto para capturar un código de autorización de eSTS. Hay casos en los que esto puede no funcionar:

• Cualquier explorador que use una forma de prevención de seguimiento inteligente
• Si no hay una sesión establecida con el servicio

En estos casos, la solicitud debe realizarse dentro de una ventana emergente o redirección de fotograma completo.

En los casos en los que se requiere interacción, no se puede enviar una solicitud con prompt=none.

Si el token de actualización ha expirado, puede usar esta función para capturar un nuevo conjunto de tokens de forma silenciosa, siempre y cuando la sesión en el servidor siga existiendo.

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

Parámetros

Devoluciones

Promesa que se cumple cuando se ha completado esta función o se rechaza si se ha generado un error.

Heredado de PublicClientApplication.ssoSilent