IPublicClientApplication interface

Pakiet:

@azure/msal-node

Interfejs klasy PublicClientApplication definiujący publiczne sygnatury interfejsu API

Metody

acquireTokenByCode(AuthorizationCodeRequest)	Uzyskuje token przez wymianę kodu autoryzacji otrzymanego z pierwszego kroku przepływu kodu autoryzacji OAuth 2.0
acquireTokenByDeviceCode(DeviceCodeRequest)	Uzyskuje token z urzędu przy użyciu przepływu kodu urządzenia OAuth2.0
acquireTokenByRefreshToken(RefreshTokenRequest)	Uzyskuje token przez wymianę tokenu odświeżania dostarczonego dla nowego zestawu tokenów
acquireTokenByUsernamePassword(UsernamePasswordRequest)	Uzyskuje tokeny z przyznawaniem haseł przez wymianę nazwy użytkownika i hasła aplikacji klienckich na potrzeby poświadczeń
acquireTokenInteractive(InteractiveRequest)	Uzyskuje token interaktywnie
acquireTokenSilent(SilentFlowRequest)	Uzyskuje token w trybie dyskretnym, gdy użytkownik określa konto, dla którego zażądano tokenu
clearCache()	Wyczyść pamięć podręczną
getAllAccounts()	Pobiera wszystkie buforowane konta
getAuthCodeUrl(AuthorizationUrlRequest)	Tworzy adres URL żądania autoryzacji
getLogger()	Zwraca wystąpienie rejestratora
getTokenCache()	Pobiera pamięć podręczną tokenu dla aplikacji
setLogger(Logger)	Zamienia domyślny zestaw rejestratora w konfiguracjach na nowy rejestrator z nowymi konfiguracjami
signOut(SignOutRequest)	Usuwa artefakty pamięci podręcznej skojarzone z danym kontem

Szczegóły metody

acquireTokenByCode(AuthorizationCodeRequest)

Uzyskuje token przez wymianę kodu autoryzacji otrzymanego z pierwszego kroku przepływu kodu autoryzacji OAuth 2.0

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

Parametry

request

AuthorizationCodeRequest

Zwraca

Promise<AuthenticationResult>

acquireTokenByDeviceCode(DeviceCodeRequest)

Uzyskuje token z urzędu przy użyciu przepływu kodu urządzenia OAuth2.0

function acquireTokenByDeviceCode(request: DeviceCodeRequest): Promise<null | AuthenticationResult>

Parametry

request

DeviceCodeRequest

Zwraca

Promise<null | AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

Uzyskuje token przez wymianę tokenu odświeżania dostarczonego dla nowego zestawu tokenów

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

Parametry

request

RefreshTokenRequest

Zwraca

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

• Use a more secure flow instead

Uzyskuje tokeny z przyznawaniem haseł przez wymianę nazwy użytkownika i hasła aplikacji klienckich na potrzeby poświadczeń

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

Parametry

request

UsernamePasswordRequest

Zwraca

Promise<null | AuthenticationResult>

acquireTokenInteractive(InteractiveRequest)

Uzyskuje token interaktywnie

function acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult>

Parametry

request

InteractiveRequest

Zwraca

Promise<AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

Uzyskuje token w trybie dyskretnym, gdy użytkownik określa konto, dla którego zażądano tokenu

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

Parametry

request

SilentFlowRequest

Zwraca

Promise<AuthenticationResult>

clearCache()

Wyczyść pamięć podręczną

function clearCache()

getAllAccounts()

Pobiera wszystkie buforowane konta

function getAllAccounts(): Promise<AccountInfo[]>

Zwraca

Promise<AccountInfo[]>

getAuthCodeUrl(AuthorizationUrlRequest)

Tworzy adres URL żądania autoryzacji

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

Parametry

request

AuthorizationUrlRequest

Zwraca

Promise<string>

getLogger()

Zwraca wystąpienie rejestratora

function getLogger(): Logger

Zwraca

Logger

getTokenCache()

Pobiera pamięć podręczną tokenu dla aplikacji

function getTokenCache(): TokenCache

Zwraca

TokenCache

setLogger(Logger)

Zamienia domyślny zestaw rejestratora w konfiguracjach na nowy rejestrator z nowymi konfiguracjami

function setLogger(logger: Logger)

Parametry

logger

Logger

signOut(SignOutRequest)

Usuwa artefakty pamięci podręcznej skojarzone z danym kontem

function signOut(request: SignOutRequest): Promise<void>

Parametry

request

SignOutRequest

Zwraca

Promise<void>