ClientApplication class

Clase abstracta base para todas las clientApplications: pública y confidencial

Métodos

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Adquiere un token intercambiando el código de autorización recibido del primer paso del flujo de código de autorización de OAuth2.0.

getAuthCodeUrl(AuthorizationCodeUrlRequest) se puede usar para crear la dirección URL para el primer paso del flujo de código de autorización de OAuth2.0. Asegúrese de que los valores de redirectUri y ámbitos de AuthorizationCodeUrlRequest y AuthorizationCodeRequest son los mismos.

acquireTokenByRefreshToken(RefreshTokenRequest)

Adquiere un token intercambiando el token de actualización proporcionado para un nuevo conjunto de tokens.

Esta API solo se proporciona para escenarios en los que desea migrar de ADAL a MSAL. De lo contrario, se recomienda usar acquireTokenSilent() para escenarios silenciosos. Al usar acquireTokenSilent(), MSAL controlará el almacenamiento en caché y la actualización de tokens automáticamente.

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Adquiere tokens con concesión de contraseña intercambiando el nombre de usuario y la contraseña de las aplicaciones cliente para las credenciales.

El procedimiento actual de seguridad de OAuth 2.0 más reciente no permite la concesión de contraseña por completo. Encontrará más información sobre esta recomendación en https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 la documentación y las recomendaciones de Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

acquireTokenSilent(SilentFlowRequest)

Adquiere un token de forma silenciosa cuando un usuario especifica la cuenta para la que se solicita el token.

Esta API espera que el usuario proporcione un objeto de cuenta y busque la memoria caché para recuperar el token si está presente. También hay un booleano opcional "forceRefresh" que el usuario puede enviar para omitir la memoria caché de access_token y id_token. En caso de que el refresh_token haya expirado o no se encuentre, se produce un error y la guía es que el usuario llame a cualquier API de adquisición de tokens interactiva (por ejemplo: acquireTokenByCode()).

clearCache()

Borrar la memoria caché

getAuthCodeUrl(AuthorizationUrlRequest)

Crea la dirección URL de la solicitud de autorización, lo que permite al usuario escribir las credenciales y dar su consentimiento a la aplicación. La dirección URL tiene como destino el punto de conexión /authorize de la autoridad configurada en el objeto de aplicación.

Una vez que el usuario escriba sus credenciales y consentimientos, la autoridad enviará una respuesta al URI de redireccionamiento enviado en la solicitud y debe contener un código de autorización, que luego se puede usar para adquirir tokens a través acquireTokenByCode(AuthorizationCodeRequest)de .

getLogger()

Devuelve la instancia del registrador.

getTokenCache()

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

setLogger(Logger)

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

Detalles del método

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Adquiere un token intercambiando el código de autorización recibido del primer paso del flujo de código de autorización de OAuth2.0.

getAuthCodeUrl(AuthorizationCodeUrlRequest) se puede usar para crear la dirección URL para el primer paso del flujo de código de autorización de OAuth2.0. Asegúrese de que los valores de redirectUri y ámbitos de AuthorizationCodeUrlRequest y AuthorizationCodeRequest son los mismos.

function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>

Parámetros

authCodePayLoad
AuthorizationCodePayload

Devoluciones

acquireTokenByRefreshToken(RefreshTokenRequest)

Adquiere un token intercambiando el token de actualización proporcionado para un nuevo conjunto de tokens.

Esta API solo se proporciona para escenarios en los que desea migrar de ADAL a MSAL. De lo contrario, se recomienda usar acquireTokenSilent() para escenarios silenciosos. Al usar acquireTokenSilent(), MSAL controlará el almacenamiento en caché y la actualización de tokens automáticamente.

function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>

Parámetros

Devoluciones

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Advertencia

Esta API ya está en desuso.

  • Use a more secure flow instead

Adquiere tokens con concesión de contraseña intercambiando el nombre de usuario y la contraseña de las aplicaciones cliente para las credenciales.

El procedimiento actual de seguridad de OAuth 2.0 más reciente no permite la concesión de contraseña por completo. Encontrará más información sobre esta recomendación en https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 la documentación y las recomendaciones de Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>

Parámetros

request
UsernamePasswordRequest

UsenamePasswordRequest

Devoluciones

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

Adquiere un token de forma silenciosa cuando un usuario especifica la cuenta para la que se solicita el token.

Esta API espera que el usuario proporcione un objeto de cuenta y busque la memoria caché para recuperar el token si está presente. También hay un booleano opcional "forceRefresh" que el usuario puede enviar para omitir la memoria caché de access_token y id_token. En caso de que el refresh_token haya expirado o no se encuentre, se produce un error y la guía es que el usuario llame a cualquier API de adquisición de tokens interactiva (por ejemplo: acquireTokenByCode()).

function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>

Parámetros

Devoluciones

clearCache()

Borrar la memoria caché

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

Crea la dirección URL de la solicitud de autorización, lo que permite al usuario escribir las credenciales y dar su consentimiento a la aplicación. La dirección URL tiene como destino el punto de conexión /authorize de la autoridad configurada en el objeto de aplicación.

Una vez que el usuario escriba sus credenciales y consentimientos, la autoridad enviará una respuesta al URI de redireccionamiento enviado en la solicitud y debe contener un código de autorización, que luego se puede usar para adquirir tokens a través acquireTokenByCode(AuthorizationCodeRequest)de .

function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>

Parámetros

Devoluciones

Promise<string>

getLogger()

Devuelve la instancia del registrador.

function getLogger(): Logger

Devoluciones

getTokenCache()

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

function getTokenCache(): TokenCache

Devoluciones

setLogger(Logger)

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

function setLogger(logger: Logger)

Parámetros

logger
Logger

Instancia del registrador