ClientApplication class

Grundläggande abstrakt klass för alla ClientApplications – offentlig och konfidentiell

Metoder

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Hämtar en token genom att byta ut auktoriseringskoden från det första steget i OAuth2.0 Authorization Code-flödet.

getAuthCodeUrl(AuthorizationCodeUrlRequest) kan användas för att skapa URL:en för det första steget i OAuth2.0 Authorization Code-flödet. Se till att värdena för redirectUri och omfång i AuthorizationCodeUrlRequest och AuthorizationCodeRequest är desamma.

acquireTokenByRefreshToken(RefreshTokenRequest)

Hämtar en token genom att utbyta uppdateringstoken som tillhandahålls för en ny uppsättning token.

Det här API:et tillhandahålls endast för scenarier där du vill migrera från ADAL till MSAL. Annars rekommenderar vi att du använder acquireTokenSilent() för tysta scenarier. När du använder acquireTokenSilent()hanterar MSAL cachelagring och uppdatering av token automatiskt.

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Hämtar token med lösenordstilldelning genom att byta användarnamn och lösenord för klientprogram mot autentiseringsuppgifter

Den senaste OAuth 2.0 Security Best Current Practice tillåter inte att lösenordet beviljas helt. Mer information om den här rekommendationen finns i https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 Microsoft dokumentation och rekommendationer finns på:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

acquireTokenSilent(SilentFlowRequest)

Hämtar en token tyst när en användare anger det konto som token begärs för.

Det här API:et förväntar sig att användaren tillhandahåller ett kontoobjekt och tittar in i cacheminnet för att hämta token om det finns. Det finns också ett valfritt "forceRefresh"-booleskt värde som användaren kan skicka för att kringgå cacheminnet för access_token och id_token. Om refresh_token har upphört att gälla eller inte hittas utlöses ett fel och vägledningen är att användaren anropar ett API för interaktiv tokenanskaffning (t.ex. ). acquireTokenByCode()

clearCache()

Rensa cachen

getAuthCodeUrl(AuthorizationUrlRequest)

Skapar URL:en för auktoriseringsbegäran så att användaren kan ange autentiseringsuppgifter och godkänna programmet. URL:en riktar sig till slutpunkten /authorize för den utfärdare som konfigurerats i programobjektet.

När användaren har angett sina autentiseringsuppgifter och medgivanden skickar utfärdaren ett svar till omdirigerings-URI:n som skickas i begäran och ska innehålla en auktoriseringskod som sedan kan användas för att hämta token via acquireTokenByCode(AuthorizationCodeRequest).

getLogger()

Returnerar logger-instansen

getTokenCache()

Hämtar tokencachen för programmet.

setLogger(Logger)

Ersätter standardloggningsuppsättningen i konfigurationer med nya Logger med nya konfigurationer

Metodinformation

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Hämtar en token genom att byta ut auktoriseringskoden från det första steget i OAuth2.0 Authorization Code-flödet.

getAuthCodeUrl(AuthorizationCodeUrlRequest) kan användas för att skapa URL:en för det första steget i OAuth2.0 Authorization Code-flödet. Se till att värdena för redirectUri och omfång i AuthorizationCodeUrlRequest och AuthorizationCodeRequest är desamma.

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

Parametrar

authCodePayLoad
AuthorizationCodePayload

Returer

acquireTokenByRefreshToken(RefreshTokenRequest)

Hämtar en token genom att utbyta uppdateringstoken som tillhandahålls för en ny uppsättning token.

Det här API:et tillhandahålls endast för scenarier där du vill migrera från ADAL till MSAL. Annars rekommenderar vi att du använder acquireTokenSilent() för tysta scenarier. När du använder acquireTokenSilent()hanterar MSAL cachelagring och uppdatering av token automatiskt.

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

Parametrar

Returer

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Varning

Det här API:et är nu inaktuellt.

  • Use a more secure flow instead

Hämtar token med lösenordstilldelning genom att byta användarnamn och lösenord för klientprogram mot autentiseringsuppgifter

Den senaste OAuth 2.0 Security Best Current Practice tillåter inte att lösenordet beviljas helt. Mer information om den här rekommendationen finns i https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 Microsoft dokumentation och rekommendationer finns på:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

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

Parametrar

request
UsernamePasswordRequest

UsenamePasswordRequest

Returer

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

Hämtar en token tyst när en användare anger det konto som token begärs för.

Det här API:et förväntar sig att användaren tillhandahåller ett kontoobjekt och tittar in i cacheminnet för att hämta token om det finns. Det finns också ett valfritt "forceRefresh"-booleskt värde som användaren kan skicka för att kringgå cacheminnet för access_token och id_token. Om refresh_token har upphört att gälla eller inte hittas utlöses ett fel och vägledningen är att användaren anropar ett API för interaktiv tokenanskaffning (t.ex. ). acquireTokenByCode()

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

Parametrar

Returer

clearCache()

Rensa cachen

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

Skapar URL:en för auktoriseringsbegäran så att användaren kan ange autentiseringsuppgifter och godkänna programmet. URL:en riktar sig till slutpunkten /authorize för den utfärdare som konfigurerats i programobjektet.

När användaren har angett sina autentiseringsuppgifter och medgivanden skickar utfärdaren ett svar till omdirigerings-URI:n som skickas i begäran och ska innehålla en auktoriseringskod som sedan kan användas för att hämta token via acquireTokenByCode(AuthorizationCodeRequest).

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

Parametrar

Returer

Promise<string>

getLogger()

Returnerar logger-instansen

function getLogger(): Logger

Returer

getTokenCache()

Hämtar tokencachen för programmet.

function getTokenCache(): TokenCache

Returer

setLogger(Logger)

Ersätter standardloggningsuppsättningen i konfigurationer med nya Logger med nya konfigurationer

function setLogger(logger: Logger)

Parametrar

logger
Logger

Logger-instans