ClientApplication class

Abstracte basisklasse voor alle ClientApplications - openbaar en vertrouwelijk

Methoden

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Hiermee verkrijgt u een token door de autorisatiecode uit te wisselen die is ontvangen uit de eerste stap van de OAuth2.0-autorisatiecodestroom.

getAuthCodeUrl(AuthorizationCodeUrlRequest) kan worden gebruikt om de URL te maken voor de eerste stap van de OAuth2.0-autorisatiecodestroom. Zorg ervoor dat waarden voor redirectUri en scopes in AuthorizationCodeUrlRequest en AuthorizationCodeRequest hetzelfde zijn.

acquireTokenByRefreshToken(RefreshTokenRequest)

Hiermee verkrijgt u een token door het vernieuwingstoken uit te wisselen dat is opgegeven voor een nieuwe set tokens.

Deze API is alleen beschikbaar voor scenario's waarin u wilt migreren van ADAL naar MSAL. Anders wordt het aanbevolen om te gebruiken acquireTokenSilent() voor stille scenario's. Wanneer u msal gebruikt acquireTokenSilent(), wordt de cache en het vernieuwen van tokens automatisch verwerkt.

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Hiermee verkrijgt u tokens met wachtwoordtoekenning door de gebruikersnaam en het wachtwoord van clienttoepassingen uit te wisselen voor referenties

De meest recente best practice voor OAuth 2.0-beveiliging staat niet toe dat het wachtwoord volledig wordt verleend. Meer informatie over deze aanbeveling vindt u in https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 de documentatie en aanbevelingen van Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

acquireTokenSilent(SilentFlowRequest)

Hiermee verkrijgt u een token op de achtergrond wanneer een gebruiker het account opgeeft waarvoor het token wordt aangevraagd.

Deze API verwacht dat de gebruiker een accountobject opgeeft en in de cache kijkt om het token op te halen als dit aanwezig is. Er is ook een optionele forceRefresh-booleaanse waarde die de gebruiker kan verzenden om de cache voor access_token en id_token te omzeilen. Als de refresh_token is verlopen of niet wordt gevonden, wordt er een fout gegenereerd en wordt de gebruiker begeleid bij het aanroepen van een interactieve tokenverwervings-API (bijvoorbeeld: acquireTokenByCode()).

clearCache()

Cache legen

getAuthCodeUrl(AuthorizationUrlRequest)

Hiermee maakt u de URL van de autorisatieaanvraag, zodat de gebruikersreferenties kunnen invoeren en toestemming kunnen geven voor de toepassing. De URL is gericht op het eindpunt /authorize van de instantie die is geconfigureerd in het toepassingsobject.

Zodra de gebruiker zijn referenties en toestemmingen invoert, stuurt de autoriteit een antwoord naar de omleidings-URI die in de aanvraag is verzonden en moet deze een autorisatiecode bevatten, die vervolgens kan worden gebruikt om tokens te verkrijgen via acquireTokenByCode(AuthorizationCodeRequest).

getLogger()

Retourneert het loggerexemplaren

getTokenCache()

Hiermee haalt u de tokencache voor de toepassing op.

setLogger(Logger)

Vervangt de standaardlogger die is ingesteld in configuraties door nieuwe logger door nieuwe configuraties

Methodedetails

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Hiermee verkrijgt u een token door de autorisatiecode uit te wisselen die is ontvangen uit de eerste stap van de OAuth2.0-autorisatiecodestroom.

getAuthCodeUrl(AuthorizationCodeUrlRequest) kan worden gebruikt om de URL te maken voor de eerste stap van de OAuth2.0-autorisatiecodestroom. Zorg ervoor dat waarden voor redirectUri en scopes in AuthorizationCodeUrlRequest en AuthorizationCodeRequest hetzelfde zijn.

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

Parameters

authCodePayLoad
AuthorizationCodePayload

Retouren

acquireTokenByRefreshToken(RefreshTokenRequest)

Hiermee verkrijgt u een token door het vernieuwingstoken uit te wisselen dat is opgegeven voor een nieuwe set tokens.

Deze API is alleen beschikbaar voor scenario's waarin u wilt migreren van ADAL naar MSAL. Anders wordt het aanbevolen om te gebruiken acquireTokenSilent() voor stille scenario's. Wanneer u msal gebruikt acquireTokenSilent(), wordt de cache en het vernieuwen van tokens automatisch verwerkt.

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

Parameters

Retouren

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Waarschuwing

Deze API is nu afgeschaft.

  • Use a more secure flow instead

Hiermee verkrijgt u tokens met wachtwoordtoekenning door de gebruikersnaam en het wachtwoord van clienttoepassingen uit te wisselen voor referenties

De meest recente best practice voor OAuth 2.0-beveiliging staat niet toe dat het wachtwoord volledig wordt verleend. Meer informatie over deze aanbeveling vindt u in https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 de documentatie en aanbevelingen van Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

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

Parameters

request
UsernamePasswordRequest

UsenamePasswordRequest

Retouren

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

Hiermee verkrijgt u een token op de achtergrond wanneer een gebruiker het account opgeeft waarvoor het token wordt aangevraagd.

Deze API verwacht dat de gebruiker een accountobject opgeeft en in de cache kijkt om het token op te halen als dit aanwezig is. Er is ook een optionele forceRefresh-booleaanse waarde die de gebruiker kan verzenden om de cache voor access_token en id_token te omzeilen. Als de refresh_token is verlopen of niet wordt gevonden, wordt er een fout gegenereerd en wordt de gebruiker begeleid bij het aanroepen van een interactieve tokenverwervings-API (bijvoorbeeld: acquireTokenByCode()).

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

Parameters

Retouren

clearCache()

Cache legen

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

Hiermee maakt u de URL van de autorisatieaanvraag, zodat de gebruikersreferenties kunnen invoeren en toestemming kunnen geven voor de toepassing. De URL is gericht op het eindpunt /authorize van de instantie die is geconfigureerd in het toepassingsobject.

Zodra de gebruiker zijn referenties en toestemmingen invoert, stuurt de autoriteit een antwoord naar de omleidings-URI die in de aanvraag is verzonden en moet deze een autorisatiecode bevatten, die vervolgens kan worden gebruikt om tokens te verkrijgen via acquireTokenByCode(AuthorizationCodeRequest).

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

Parameters

Retouren

Promise<string>

getLogger()

Retourneert het loggerexemplaren

function getLogger(): Logger

Retouren

getTokenCache()

Hiermee haalt u de tokencache voor de toepassing op.

function getTokenCache(): TokenCache

Retouren

setLogger(Logger)

Vervangt de standaardlogger die is ingesteld in configuraties door nieuwe logger door nieuwe configuraties

function setLogger(logger: Logger)

Parameters

logger
Logger

Loggerexemplaren