ClientApplication class

Pakiet:: @azure/msal-node

Podstawowa klasa abstrakcyjna dla wszystkich aplikacji ClientApplications — publiczna i poufne

Metody

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)	Uzyskuje token przez wymianę kodu autoryzacji otrzymanego z pierwszego kroku przepływu kodu autoryzacji OAuth2.0. `getAuthCodeUrl(AuthorizationCodeUrlRequest)` Można użyć do utworzenia adresu URL pierwszego kroku przepływu kodu autoryzacji OAuth2.0. Upewnij się, że wartości identyfikatorów redirectUri i zakresów w polach AuthorizationCodeUrlRequest i AuthorizationCodeRequest są takie same.
acquireTokenByRefreshToken(RefreshTokenRequest)	Uzyskuje token, wymieniając token odświeżania udostępniony dla nowego zestawu tokenów. Ten interfejs API jest udostępniany tylko w scenariuszach, w których chcesz przeprowadzić migrację z biblioteki ADAL do biblioteki MSAL. W przeciwnym razie zaleca się używanie ich `acquireTokenSilent()` w scenariuszach dyskretnych. W przypadku używania biblioteki `acquireTokenSilent()`MSAL będzie automatycznie obsługiwać buforowanie i odświeżanie tokenów.
acquireTokenByUsernamePassword(UsernamePasswordRequest)	Uzyskuje tokeny z przyznawaniem haseł przez wymianę nazwy użytkownika i hasła aplikacji klienckich na potrzeby poświadczeń Najnowsze najlepsze rozwiązania dotyczące zabezpieczeń protokołu OAuth 2.0 nie zezwalają na całkowite przyznanie hasła. Więcej szczegółów na temat tego zalecenia można znaleźć w https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 dokumentacji i zaleceniach Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
acquireTokenSilent(SilentFlowRequest)	Uzyskuje token w trybie dyskretnym, gdy użytkownik określa konto, dla którego żądany jest token. Ten interfejs API oczekuje, że użytkownik udostępni obiekt konta i zagląda do pamięci podręcznej w celu pobrania tokenu, jeśli istnieje. Istnieje również opcjonalny element logiczny "forceRefresh", który użytkownik może wysłać, aby pominąć pamięć podręczną dla access_token i id_token. Jeśli refresh_token wygasł lub nie zostanie znaleziony, zostanie zgłoszony błąd, a wskazówki dotyczą użytkownika wywołania dowolnego interaktywnego interfejsu API pozyskiwania tokenu (np. `acquireTokenByCode()`).
clearCache()	Wyczyść pamięć podręczną
getAuthCodeUrl(AuthorizationUrlRequest)	Tworzy adres URL żądania autoryzacji, umożliwiając użytkownikowi wprowadzanie poświadczeń i wyrażanie zgody na aplikację. Adres URL jest przeznaczony dla /authorize punktu końcowego urzędu skonfigurowanego w obiekcie aplikacji. Gdy użytkownik wprowadzi swoje poświadczenia i zgody, urząd wyśle odpowiedź do identyfikatora URI przekierowania wysłanego w żądaniu i powinien zawierać kod autoryzacji, który następnie może służyć do uzyskiwania tokenów za pośrednictwem metody `acquireTokenByCode(AuthorizationCodeRequest)`.
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

Szczegóły metody

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Uzyskuje token przez wymianę kodu autoryzacji otrzymanego z pierwszego kroku przepływu kodu autoryzacji OAuth2.0.

getAuthCodeUrl(AuthorizationCodeUrlRequest) Można użyć do utworzenia adresu URL pierwszego kroku przepływu kodu autoryzacji OAuth2.0. Upewnij się, że wartości identyfikatorów redirectUri i zakresów w polach AuthorizationCodeUrlRequest i AuthorizationCodeRequest są takie same.

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

Parametry

request: AuthorizationCodeRequest

authCodePayLoad: AuthorizationCodePayload

Zwraca

Promise<AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

Uzyskuje token, wymieniając token odświeżania udostępniony dla nowego zestawu tokenów.

Ten interfejs API jest udostępniany tylko w scenariuszach, w których chcesz przeprowadzić migrację z biblioteki ADAL do biblioteki MSAL. W przeciwnym razie zaleca się używanie ich acquireTokenSilent() w scenariuszach dyskretnych. W przypadku używania biblioteki acquireTokenSilent()MSAL będzie automatycznie obsługiwać buforowanie i odświeżanie 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ń

Najnowsze najlepsze rozwiązania dotyczące zabezpieczeń protokołu OAuth 2.0 nie zezwalają na całkowite przyznanie hasła. Więcej szczegółów na temat tego zalecenia można znaleźć w https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 dokumentacji i zaleceniach Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

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

Parametry

request: UsernamePasswordRequest

UsenamePasswordRequest

Zwraca

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

Uzyskuje token w trybie dyskretnym, gdy użytkownik określa konto, dla którego żądany jest token.

Ten interfejs API oczekuje, że użytkownik udostępni obiekt konta i zagląda do pamięci podręcznej w celu pobrania tokenu, jeśli istnieje. Istnieje również opcjonalny element logiczny "forceRefresh", który użytkownik może wysłać, aby pominąć pamięć podręczną dla access_token i id_token. Jeśli refresh_token wygasł lub nie zostanie znaleziony, zostanie zgłoszony błąd, a wskazówki dotyczą użytkownika wywołania dowolnego interaktywnego interfejsu API pozyskiwania tokenu (np. acquireTokenByCode()).

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

Parametry

request: SilentFlowRequest

Zwraca

Promise<AuthenticationResult>

clearCache()

Wyczyść pamięć podręczną

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

Tworzy adres URL żądania autoryzacji, umożliwiając użytkownikowi wprowadzanie poświadczeń i wyrażanie zgody na aplikację. Adres URL jest przeznaczony dla /authorize punktu końcowego urzędu skonfigurowanego w obiekcie aplikacji.

Gdy użytkownik wprowadzi swoje poświadczenia i zgody, urząd wyśle odpowiedź do identyfikatora URI przekierowania wysłanego w żądaniu i powinien zawierać kod autoryzacji, który następnie może służyć do uzyskiwania tokenów za pośrednictwem metody acquireTokenByCode(AuthorizationCodeRequest).

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

Wystąpienie rejestratora