CustomAuthPublicClientApplication class

Metody

create(CustomAuthConfiguration)	Tworzy nowe wystąpienie klasy PublicClientApplication z daną konfiguracją i kontrolerem w celu uruchomienia przepływów uwierzytelniania natywnego
getCurrentAccount(CustomAuthActionInputs)	Pobiera bieżące konto z pamięci podręcznej przeglądarki.
resetPassword(ResetPasswordInputs)	Inicjuje przepływ resetowania hasła. Ta metoda powoduje wyzwolenie dodatkowej akcji (prześlij kod) w celu ukończenia resetowania hasła. Utwórz wynik ze szczegółami błędu, jeśli zostanie zgłoszony wyjątek.
signIn(SignInInputs)	Inicjuje przepływ logowania. Ta metoda powoduje ukończenie logowania lub dodatkowe akcje (hasło, kod itp.) wymagane do ukończenia logowania. Utwórz wynik ze szczegółami błędu, jeśli zostanie zgłoszony wyjątek.
signUp(SignUpInputs)	Inicjuje przepływ rejestracji. Ta metoda powoduje ukończenie rejestracji lub dodatkowe akcje (hasło, kod itp.) wymagane do ukończenia rejestracji. Utwórz wynik ze szczegółami błędu, jeśli zostanie zgłoszony wyjątek.

Metody dziedziczone

acquireTokenByCode(AuthorizationCodeRequest)	Ta funkcja wykonuje kod autoryzacji (przekazany jako kod) z punktu końcowego tokenu eSTS. Ten kod autoryzacji należy uzyskać po stronie serwera przy użyciu poufnego klienta w celu uzyskania spa_code. Ten interfejs API nie jest niezadendowany w przypadku normalnego uzyskiwania i realizacji kodu autoryzacji. Realizacja tego kodu autoryzacji nie będzie wymagać klucza PKCE, ponieważ został on uzyskany przez poufnego klienta.
acquireTokenPopup(PopupRequest)	Użyj polecenia , aby uzyskać access_token dla interfejsu API za pomocą otwierania okna podręcznego w przeglądarce użytkownika
acquireTokenRedirect(RedirectRequest)	Użyj polecenia , aby uzyskać access_token dla interfejsu API, przekierowując okno przeglądarki użytkownika do punktu końcowego autoryzacji. Ta funkcja przekierowuje stronę, więc żaden kod zgodny z tą funkcją nie zostanie wykonany. WAŻNE: NIE zaleca się posiadania kodu zależnego od rozwiązania obietnicy. Ta funkcja przejdzie z dala od bieżącego okna przeglądarki. Obecnie zwraca wartość Promise w celu odzwierciedlenia asynchronicznego charakteru kodu uruchomionego w tej funkcji.
acquireTokenSilent(SilentRequest)	Dyskretne uzyskiwanie tokenu dostępu dla danego zestawu zakresów. Zwraca obecnie przetwarzanie obietnicy, jeśli są wykonywane żądania równoległe.
addEventCallback(EventCallbackFunction, EventType[])	Dodaje wywołania zwrotne zdarzeń do tablicy
addPerformanceCallback(PerformanceCallbackFunction)	Rejestruje wywołanie zwrotne w celu odbierania zdarzeń wydajności.
clearCache(ClearCacheRequest)	Czyści tokeny i konto z pamięci podręcznej przeglądarki.
createPublicClientApplication(Configuration)	Tworzy standardController i przekazuje go do elementu PublicClientApplication
disableAccountStorageEvents()	Usuwa odbiornik zdarzeń, który emituje zdarzenie po dodaniu lub usunięciu konta użytkownika z magazynu lokalnego na innej karcie lub oknie przeglądarki
enableAccountStorageEvents()	Dodaje odbiornik zdarzeń, który emituje zdarzenie po dodaniu lub usunięciu konta użytkownika z magazynu lokalnego na innej karcie lub w innym oknie przeglądarki
getAccount(AccountFilter)	Zwraca pierwsze konto znalezione w pamięci podręcznej zgodne z filtrem konta przekazanym.
getAccountByHomeId(string)	Zwraca zalogowane konto zgodne z parametrem homeAccountId. (obiekt konta jest tworzony w momencie pomyślnego logowania) lub null, gdy nie znaleziono pasującego konta
getAccountByLocalId(string)	Zwraca zalogowane konto zgodne z identyfikatorem localAccountId. (obiekt konta jest tworzony w momencie pomyślnego logowania) lub null, gdy nie znaleziono pasującego konta
getAccountByUsername(string)	Zwraca zalogowaną nazwę użytkownika zgodną z kontem. (obiekt konta jest tworzony w momencie pomyślnego logowania) lub null po znalezieniu pasującego konta. Ten interfejs API jest udostępniany dla wygody, ale parametr getAccountById powinien być używany w celu uzyskania najlepszej niezawodności
getActiveAccount()	Pobiera aktualnie aktywne konto
getAllAccounts(AccountFilter)	Zwraca wszystkie konta w pamięci podręcznej zgodne z opcjonalnym filtrem. Jeśli nie podano żadnego filtru, zostaną zwrócone wszystkie konta.
getLogger()	Zwraca wystąpienie rejestratora
getTokenCache()	Pobiera pamięć podręczną tokenu dla aplikacji.
handleRedirectPromise(string)	Funkcja obsługi zdarzeń, która umożliwia użytkownikom wyzwalanie zdarzeń po załadowaniu obiektu PublicClientApplication podczas przepływów przekierowania. Powinno to być wywoływane na wszystkich obciążeniach strony zaangażowanych w przepływy uwierzytelniania przekierowania.
hydrateCache(AuthenticationResult, PopupRequest \| RedirectRequest \| SilentRequest \| Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" \| "earJwk" \| "codeChallenge" \| "codeChallengeMethod" \| "requestedClaimsHash" \| "platformBroker">>)	Nawilża pamięć podręczną przy użyciu tokenów i konta w obiekcie AuthenticationResult
initialize(InitializeApplicationRequest)	Funkcja initializer do wykonywania zadań uruchamiania asynchronicznego, takich jak nawiązywanie połączenia z rozszerzeniem WAM
initializeWrapperLibrary(WrapperSKU, string)	Wywoływane przez biblioteki otoki (Angular i React) w celu ustawienia jednostki SKU i wersji przekazywanej do telemetrii, rejestratora itp.
loginPopup(PopupRequest)	Użyj polecenia podczas inicjowania procesu logowania za pomocą otwierania okna podręcznego w przeglądarce użytkownika
loginRedirect(RedirectRequest)	Użyj polecenia podczas inicjowania procesu logowania, przekierowując przeglądarkę użytkownika do punktu końcowego autoryzacji. Ta funkcja przekierowuje stronę, więc żaden kod zgodny z tą funkcją nie zostanie wykonany. WAŻNE: NIE zaleca się posiadania kodu zależnego od rozwiązania obietnicy. Ta funkcja przejdzie z dala od bieżącego okna przeglądarki. Obecnie zwraca wartość Promise w celu odzwierciedlenia asynchronicznego charakteru kodu uruchomionego w tej funkcji.
logout(EndSessionRequest)	Przestarzała funkcja wylogowywanie. Zamiast tego użyj polecenia logoutRedirect lub logoutPopup
logoutPopup(EndSessionPopupRequest)	Czyści lokalną pamięć podręczną dla bieżącego użytkownika, a następnie otwiera okno podręczne z monitem użytkownika o wylogowanie się z serwera
logoutRedirect(EndSessionRequest)	Użyj polecenia , aby wylogować bieżącego użytkownika i przekierować użytkownika do identyfikatora postLogoutRedirectUri. Domyślnym zachowaniem jest przekierowanie użytkownika do `window.location.href`.
removeEventCallback(string)	Usuwa wywołanie zwrotne z podanym identyfikatorem z tablicy wywołań zwrotnych
removePerformanceCallback(string)	Usuwa wywołanie zwrotne zarejestrowane za pomocą polecenia addPerformanceCallback.
setActiveAccount(null \| AccountInfo)	Ustawia konto do użycia jako aktywne konto. Jeśli żadne konto nie zostanie przekazane do interfejsów API acquireToken, biblioteka MSAL użyje tego aktywnego konta.
setLogger(Logger)	Zamienia domyślny zestaw rejestratora w konfiguracjach na nowy rejestrator z nowymi konfiguracjami
setNavigationClient(INavigationClient)	Ustawia klienta nawigacji
ssoSilent(Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" \| "earJwk" \| "codeChallenge" \| "codeChallengeMethod" \| "requestedClaimsHash" \| "platformBroker">>)	Ta funkcja używa ukrytego elementu iframe do pobierania kodu autoryzacji z protokołu eSTS. Istnieją przypadki, w których może to nie działać: Każda przeglądarka korzystająca z formy inteligentnego zapobiegania śledzeniu Jeśli nie ma ustalonej sesji z usługą W takich przypadkach żądanie musi zostać wykonane wewnątrz okna podręcznego lub przekierowania pełnej ramki. W przypadkach, w których jest wymagana interakcja, nie można wysłać żądania z prompt=none. Jeśli token odświeżania wygasł, możesz użyć tej funkcji, aby pobrać nowy zestaw tokenów w trybie dyskretnym, o ile sesja na serwerze nadal istnieje.

create(CustomAuthConfiguration)

Tworzy nowe wystąpienie klasy PublicClientApplication z daną konfiguracją i kontrolerem w celu uruchomienia przepływów uwierzytelniania natywnego

static function create(config: CustomAuthConfiguration): Promise<ICustomAuthPublicClientApplication>

Parametry

config: CustomAuthConfiguration

Obiekt konfiguracji dla wystąpienia PublicClientApplication

Zwraca

Promise<ICustomAuthPublicClientApplication>

Obietnica rozpoznawana jako wystąpienie CustomAuthPublicClientApplication

getCurrentAccount(CustomAuthActionInputs)

Pobiera bieżące konto z pamięci podręcznej przeglądarki.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parametry

accountRetrievalInputs: CustomAuthActionInputs

Zwraca

GetAccountResult

Wynik operacji pobierania konta

resetPassword(ResetPasswordInputs)

Inicjuje przepływ resetowania hasła. Ta metoda powoduje wyzwolenie dodatkowej akcji (prześlij kod) w celu ukończenia resetowania hasła. Utwórz wynik ze szczegółami błędu, jeśli zostanie zgłoszony wyjątek.

function resetPassword(resetPasswordInputs: ResetPasswordInputs): Promise<ResetPasswordStartResult>

Parametry

resetPasswordInputs: ResetPasswordInputs

Dane wejściowe dla przepływu resetowania hasła

Zwraca

Promise<ResetPasswordStartResult>

Obietnica, która rozwiązuje problem z resetPasswordStartResult

Inicjuje przepływ logowania. Ta metoda powoduje ukończenie logowania lub dodatkowe akcje (hasło, kod itp.) wymagane do ukończenia logowania. Utwórz wynik ze szczegółami błędu, jeśli zostanie zgłoszony wyjątek.

function signIn(signInInputs: SignInInputs): Promise<SignInResult>

Parametry

signInInputs: SignInInputs

Dane wejściowe przepływu logowania

Zwraca

Promise<SignInResult>

Obietnica, która jest rozpoznawana jako SignInResult

Inicjuje przepływ rejestracji. Ta metoda powoduje ukończenie rejestracji lub dodatkowe akcje (hasło, kod itp.) wymagane do ukończenia rejestracji. Utwórz wynik ze szczegółami błędu, jeśli zostanie zgłoszony wyjątek.

function signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>

Parametry

signUpInputs: SignUpInputs

Zwraca

Promise<SignUpResult>

Obietnica, która rozwiązuje problem z elementem SignUpResult

acquireTokenByCode(AuthorizationCodeRequest)

Ta funkcja wykonuje kod autoryzacji (przekazany jako kod) z punktu końcowego tokenu eSTS. Ten kod autoryzacji należy uzyskać po stronie serwera przy użyciu poufnego klienta w celu uzyskania spa_code. Ten interfejs API nie jest niezadendowany w przypadku normalnego uzyskiwania i realizacji kodu autoryzacji.

Realizacja tego kodu autoryzacji nie będzie wymagać klucza PKCE, ponieważ został on uzyskany przez poufnego klienta.

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

Parametry

request: AuthorizationCodeRequest

AuthorizationCodeRequest

Zwraca

Promise<AuthenticationResult>

Obietnica spełniona po zakończeniu tej funkcji lub odrzucona, jeśli został zgłoszony błąd.

Dziedziczone z PublicClientApplication.acquireTokenByCode

acquireTokenPopup(PopupRequest)

Użyj polecenia , aby uzyskać access_token dla interfejsu API za pomocą otwierania okna podręcznego w przeglądarce użytkownika

function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>

Parametry

request: PopupRequest

Zwraca

Promise<AuthenticationResult>

Obietnica spełniona po zakończeniu tej funkcji lub odrzucona, jeśli został zgłoszony błąd.

Dziedziczone z PublicClientApplication.acquireTokenPopup

acquireTokenRedirect(RedirectRequest)

Użyj polecenia , aby uzyskać access_token dla interfejsu API, przekierowując okno przeglądarki użytkownika do punktu końcowego autoryzacji. Ta funkcja przekierowuje stronę, więc żaden kod zgodny z tą funkcją nie zostanie wykonany.

WAŻNE: NIE zaleca się posiadania kodu zależnego od rozwiązania obietnicy. Ta funkcja przejdzie z dala od bieżącego okna przeglądarki. Obecnie zwraca wartość Promise w celu odzwierciedlenia asynchronicznego charakteru kodu uruchomionego w tej funkcji.

function acquireTokenRedirect(request: RedirectRequest): Promise<void>

Parametry

request: RedirectRequest

Zwraca

Promise<void>

Dziedziczone z PublicClientApplication.acquireTokenRedirect

acquireTokenSilent(SilentRequest)

Dyskretne uzyskiwanie tokenu dostępu dla danego zestawu zakresów. Zwraca obecnie przetwarzanie obietnicy, jeśli są wykonywane żądania równoległe.

function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>

Parametry

silentRequest: SilentRequest

Zwraca

Promise<AuthenticationResult>

obietnica spełniona po zakończeniu tej funkcji lub odrzucona, jeśli został zgłoszony błąd. AuthenticationResult Zwraca obiekt

Dziedziczone z PublicClientApplication.acquireTokenSilent

addEventCallback(EventCallbackFunction, EventType[])

Dodaje wywołania zwrotne zdarzeń do tablicy

function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string

Parametry

callback: EventCallbackFunction

eventTypes: EventType[]

Zwraca

null | string

Dziedziczone z PublicClientApplication.addEventCallback

addPerformanceCallback(PerformanceCallbackFunction)

Rejestruje wywołanie zwrotne w celu odbierania zdarzeń wydajności.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametry

callback: PerformanceCallbackFunction

Zwraca

string

Dziedziczone z PublicClientApplication.addPerformanceCallback

clearCache(ClearCacheRequest)

Czyści tokeny i konto z pamięci podręcznej przeglądarki.

function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>

Parametry

logoutRequest: ClearCacheRequest

Zwraca

Promise<void>

Dziedziczone z PublicClientApplication.clearCache

createPublicClientApplication(Configuration)

Tworzy standardController i przekazuje go do elementu PublicClientApplication

static function createPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Parametry

configuration: Configuration

{Konfiguracja}

Zwraca

Promise<IPublicClientApplication>

Dziedziczone z PublicClientApplication.createPublicClientApplication

disableAccountStorageEvents()

Usuwa odbiornik zdarzeń, który emituje zdarzenie po dodaniu lub usunięciu konta użytkownika z magazynu lokalnego na innej karcie lub oknie przeglądarki

function disableAccountStorageEvents()

Dziedziczone z PublicClientApplication.disableAccountStorageEvents

enableAccountStorageEvents()

Dodaje odbiornik zdarzeń, który emituje zdarzenie po dodaniu lub usunięciu konta użytkownika z magazynu lokalnego na innej karcie lub w innym oknie przeglądarki

function enableAccountStorageEvents()

Dziedziczone z PublicClientApplication.enableAccountStorageEvents

getAccount(AccountFilter)

Zwraca pierwsze konto znalezione w pamięci podręcznej zgodne z filtrem konta przekazanym.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parametry

accountFilter: AccountFilter

Zwraca

null | AccountInfo

Pierwsze konto znalezione w pamięci podręcznej zgodne z podanym filtrem lub wartością null, jeśli nie można odnaleźć żadnego konta.

Dziedziczone z PublicClientApplication.getAccount

getAccountByHomeId(string)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getAccount instead

Zwraca zalogowane konto zgodne z parametrem homeAccountId. (obiekt konta jest tworzony w momencie pomyślnego logowania) lub null, gdy nie znaleziono pasującego konta

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parametry

homeAccountId: string

Zwraca

null | AccountInfo

Obiekt konta przechowywany w biblioteki MSAL

Dziedziczone z PublicClientApplication.getAccountByHomeId

getAccountByLocalId(string)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getAccount instead

Zwraca zalogowane konto zgodne z identyfikatorem localAccountId. (obiekt konta jest tworzony w momencie pomyślnego logowania) lub null, gdy nie znaleziono pasującego konta

function getAccountByLocalId(localId: string): null | AccountInfo

Parametry

localId: string

Zwraca

null | AccountInfo

Obiekt konta przechowywany w biblioteki MSAL

Dziedziczone z PublicClientApplication.getAccountByLocalId

getAccountByUsername(string)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use getAccount instead

Zwraca zalogowaną nazwę użytkownika zgodną z kontem. (obiekt konta jest tworzony w momencie pomyślnego logowania) lub null po znalezieniu pasującego konta. Ten interfejs API jest udostępniany dla wygody, ale parametr getAccountById powinien być używany w celu uzyskania najlepszej niezawodności

function getAccountByUsername(userName: string): null | AccountInfo

Parametry

userName: string

Zwraca

null | AccountInfo

Obiekt konta przechowywany w biblioteki MSAL

Dziedziczone z PublicClientApplication.getAccountByUsername

getActiveAccount()

Pobiera aktualnie aktywne konto

function getActiveAccount(): null | AccountInfo

Zwraca

null | AccountInfo

Dziedziczone z PublicClientApplication.getActiveAccount

getAllAccounts(AccountFilter)

Zwraca wszystkie konta w pamięci podręcznej zgodne z opcjonalnym filtrem. Jeśli nie podano żadnego filtru, zostaną zwrócone wszystkie konta.

function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]

Parametry

accountFilter: AccountFilter

(Opcjonalnie) filtr, aby zawęzić zwrócone konta

Zwraca

AccountInfo[]

Tablica obiektów AccountInfo w pamięci podręcznej

Dziedziczone z PublicClientApplication.getAllAccounts

getLogger()

Zwraca wystąpienie rejestratora

function getLogger(): Logger

Zwraca

Logger

Dziedziczone z PublicClientApplication.getLogger

getTokenCache()

Pobiera pamięć podręczną tokenu dla aplikacji.

function getTokenCache(): ITokenCache

Zwraca

ITokenCache

Dziedziczone z PublicClientApplication.getTokenCache

handleRedirectPromise(string)

Funkcja obsługi zdarzeń, która umożliwia użytkownikom wyzwalanie zdarzeń po załadowaniu obiektu PublicClientApplication podczas przepływów przekierowania. Powinno to być wywoływane na wszystkich obciążeniach strony zaangażowanych w przepływy uwierzytelniania przekierowania.

function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>

Parametry

hash: string

Skrót do przetworzenia. Wartość domyślna to bieżąca wartość parametru window.location.hash. Należy podać jawnie tylko wtedy, gdy odpowiedź do obsłużenia nie jest zawarta w bieżącej wartości.

Zwraca

Promise<null | AuthenticationResult>

Odpowiedź tokenu lub wartość null. Jeśli zwracana wartość ma wartość null, nie wykryto przekierowania uwierzytelniania.

Dziedziczone z PublicClientApplication.handleRedirectPromise

hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)

Nawilża pamięć podręczną przy użyciu tokenów i konta w obiekcie AuthenticationResult

function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>

Parametry

result: AuthenticationResult

request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>

Obiekt żądania, który został użyty do uzyskania elementu AuthenticationResult

Zwraca

Promise<void>

Dziedziczone z PublicClientApplication.hydrateCache

initialize(InitializeApplicationRequest)

Funkcja initializer do wykonywania zadań uruchamiania asynchronicznego, takich jak nawiązywanie połączenia z rozszerzeniem WAM

function initialize(request?: InitializeApplicationRequest): Promise<void>

Parametry

request: InitializeApplicationRequest

{? InitializeApplicationRequest}

Zwraca

Promise<void>

Dziedziczone z PublicClientApplication.initialize

initializeWrapperLibrary(WrapperSKU, string)

Wywoływane przez biblioteki otoki (Angular i React) w celu ustawienia jednostki SKU i wersji przekazywanej do telemetrii, rejestratora itp.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parametry

sku: WrapperSKU

version: string

Dziedziczone z PublicClientApplication.initializeWrapperLibrary

loginPopup(PopupRequest)

Użyj polecenia podczas inicjowania procesu logowania za pomocą otwierania okna podręcznego w przeglądarce użytkownika

function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>

Parametry

request: PopupRequest

Zwraca

Promise<AuthenticationResult>

Obietnica spełniona po zakończeniu tej funkcji lub odrzucona, jeśli został zgłoszony błąd.

Dziedziczone z PublicClientApplication.loginPopup

loginRedirect(RedirectRequest)

Użyj polecenia podczas inicjowania procesu logowania, przekierowując przeglądarkę użytkownika do punktu końcowego autoryzacji. Ta funkcja przekierowuje stronę, więc żaden kod zgodny z tą funkcją nie zostanie wykonany.

WAŻNE: NIE zaleca się posiadania kodu zależnego od rozwiązania obietnicy. Ta funkcja przejdzie z dala od bieżącego okna przeglądarki. Obecnie zwraca wartość Promise w celu odzwierciedlenia asynchronicznego charakteru kodu uruchomionego w tej funkcji.

function loginRedirect(request?: RedirectRequest): Promise<void>

Parametry

request: RedirectRequest

Zwraca

Promise<void>

Dziedziczone z PublicClientApplication.loginRedirect

logout(EndSessionRequest)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Przestarzała funkcja wylogowywanie. Zamiast tego użyj polecenia logoutRedirect lub logoutPopup

function logout(logoutRequest?: EndSessionRequest): Promise<void>

Parametry

logoutRequest: EndSessionRequest

Zwraca

Promise<void>

Dziedziczone z PublicClientApplication.logout

logoutPopup(EndSessionPopupRequest)

Czyści lokalną pamięć podręczną dla bieżącego użytkownika, a następnie otwiera okno podręczne z monitem użytkownika o wylogowanie się z serwera

function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>

Parametry

logoutRequest: EndSessionPopupRequest

Zwraca

Promise<void>

Dziedziczone z PublicClientApplication.logoutPopup

logoutRedirect(EndSessionRequest)

Użyj polecenia , aby wylogować bieżącego użytkownika i przekierować użytkownika do identyfikatora postLogoutRedirectUri. Domyślnym zachowaniem jest przekierowanie użytkownika do window.location.href.

function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>

Parametry

logoutRequest: EndSessionRequest

Zwraca

Promise<void>

Dziedziczone z PublicClientApplication.logoutRedirect

removeEventCallback(string)

Usuwa wywołanie zwrotne z podanym identyfikatorem z tablicy wywołań zwrotnych

function removeEventCallback(callbackId: string)

Parametry

callbackId: string

Dziedziczone z PublicClientApplication.removeEventCallback

removePerformanceCallback(string)

Usuwa wywołanie zwrotne zarejestrowane za pomocą polecenia addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametry

callbackId: string

Zwraca

boolean

Dziedziczone z PublicClientApplication.removePerformanceCallback

setActiveAccount(null | AccountInfo)

Ustawia konto do użycia jako aktywne konto. Jeśli żadne konto nie zostanie przekazane do interfejsów API acquireToken, biblioteka MSAL użyje tego aktywnego konta.

function setActiveAccount(account: null | AccountInfo)

Parametry

account: null | AccountInfo

Dziedziczone z PublicClientApplication.setActiveAccount

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

Dziedziczone z PublicClientApplication.setLogger

setNavigationClient(INavigationClient)

Ustawia klienta nawigacji

function setNavigationClient(navigationClient: INavigationClient)

Parametry

navigationClient: INavigationClient

Dziedziczone z PublicClientApplication.setNavigationClient

ssoSilent(Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)

Ta funkcja używa ukrytego elementu iframe do pobierania kodu autoryzacji z protokołu eSTS. Istnieją przypadki, w których może to nie działać:

Każda przeglądarka korzystająca z formy inteligentnego zapobiegania śledzeniu
Jeśli nie ma ustalonej sesji z usługą

W takich przypadkach żądanie musi zostać wykonane wewnątrz okna podręcznego lub przekierowania pełnej ramki.

W przypadkach, w których jest wymagana interakcja, nie można wysłać żądania z prompt=none.

Jeśli token odświeżania wygasł, możesz użyć tej funkcji, aby pobrać nowy zestaw tokenów w trybie dyskretnym, o ile sesja na serwerze nadal istnieje.

function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>

Parametry

request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>

SsoSilentRequest

Zwraca

Promise<AuthenticationResult>

Obietnica spełniona po zakończeniu tej funkcji lub odrzucona, jeśli został zgłoszony błąd.

Dziedziczone z PublicClientApplication.ssoSilent

CustomAuthPublicClientApplication class

Metody

Metody dziedziczone

Szczegóły metody

create(CustomAuthConfiguration)

Parametry

Zwraca

getCurrentAccount(CustomAuthActionInputs)

Parametry

Zwraca

resetPassword(ResetPasswordInputs)

Parametry

Zwraca

signIn(SignInInputs)

Parametry

Zwraca

signUp(SignUpInputs)

Parametry

Zwraca

Szczegóły metody dziedziczonej

acquireTokenByCode(AuthorizationCodeRequest)

Parametry

Zwraca

acquireTokenPopup(PopupRequest)

Parametry

Zwraca

acquireTokenRedirect(RedirectRequest)

Parametry

Zwraca

acquireTokenSilent(SilentRequest)

Parametry

Zwraca

addEventCallback(EventCallbackFunction, EventType[])

Parametry

Zwraca

addPerformanceCallback(PerformanceCallbackFunction)

Parametry

Zwraca

clearCache(ClearCacheRequest)

Parametry

Zwraca

createPublicClientApplication(Configuration)

Parametry

Zwraca

disableAccountStorageEvents()

enableAccountStorageEvents()

getAccount(AccountFilter)

Parametry

Zwraca

getAccountByHomeId(string)

Parametry

Zwraca

getAccountByLocalId(string)

Parametry

Zwraca

getAccountByUsername(string)

Parametry

Zwraca

getActiveAccount()

Zwraca

getAllAccounts(AccountFilter)

Parametry

Zwraca

getLogger()

Zwraca

getTokenCache()

Zwraca

handleRedirectPromise(string)

Parametry

Zwraca

hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)

Parametry

Zwraca

initialize(InitializeApplicationRequest)

Parametry

Zwraca

initializeWrapperLibrary(WrapperSKU, string)

Parametry

loginPopup(PopupRequest)

Parametry