CustomAuthAccountData class

Pakiet:

@azure/msal-browser

Konstruktory

CustomAuthAccountData(AccountInfo, CustomAuthBrowserConfiguration, CustomAuthSilentCacheClient, Logger, string)

Metody

getAccessToken(AccessTokenRetrievalInputs)	Pobiera token dostępu bieżącego konta z pamięci podręcznej przeglądarki, jeśli nie wygasł, w przeciwnym razie odnów token przy użyciu buforowanego tokenu odświeżania, jeśli jest prawidłowy. Jeśli token odświeżania nie zostanie znaleziony lub wygasł, zgłasza błąd.
getAccount()
getClaims()	Pobiera oświadczenia tokenu identyfikatora wyodrębnione z nieprzetworzonego identyfikatora IdToken bieżącego konta.
getIdToken()	Pobiera nieprzetworzone tokeny id bieżącego konta. Identyfikator idtoken jest wystawiany tylko wtedy, gdy zakres openid znajduje się w parametrze zakresów podczas żądania tokenów, w przeciwnym razie zwróci niezdefiniowane z odpowiedzi.
signOut()	Ta metoda wyzwala operację wylogowania, która usuwa informacje o bieżącym koncie i jego tokeny z pamięci podręcznej przeglądarki. Jeśli wyloguj się pomyślnie, przekierowuj stronę do adresu postLogoutRedirectUri, jeśli zostanie podana w konfiguracji.

Szczegóły konstruktora

CustomAuthAccountData(AccountInfo, CustomAuthBrowserConfiguration, CustomAuthSilentCacheClient, Logger, string)

new CustomAuthAccountData(account: AccountInfo, config: CustomAuthBrowserConfiguration, cacheClient: CustomAuthSilentCacheClient, logger: Logger, correlationId: string)

Parametry

account

AccountInfo

config

CustomAuthBrowserConfiguration

cacheClient

CustomAuthSilentCacheClient

logger

Logger

correlationId

string

Szczegóły metody

getAccessToken(AccessTokenRetrievalInputs)

Pobiera token dostępu bieżącego konta z pamięci podręcznej przeglądarki, jeśli nie wygasł, w przeciwnym razie odnów token przy użyciu buforowanego tokenu odświeżania, jeśli jest prawidłowy. Jeśli token odświeżania nie zostanie znaleziony lub wygasł, zgłasza błąd.

function getAccessToken(accessTokenRetrievalInputs: AccessTokenRetrievalInputs): Promise<GetAccessTokenResult>

Parametry

accessTokenRetrievalInputs

AccessTokenRetrievalInputs

Dane wejściowe do pobierania tokenu dostępu.

Zwraca

Promise<GetAccessTokenResult>

Wynik operacji.

getAccount()

function getAccount(): AccountInfo

Zwraca

AccountInfo

getClaims()

Pobiera oświadczenia tokenu identyfikatora wyodrębnione z nieprzetworzonego identyfikatora IdToken bieżącego konta.

function getClaims(): undefined | AuthTokenClaims

Zwraca

undefined | AuthTokenClaims

Oświadczenia tokenu.

getIdToken()

Pobiera nieprzetworzone tokeny id bieżącego konta. Identyfikator idtoken jest wystawiany tylko wtedy, gdy zakres openid znajduje się w parametrze zakresów podczas żądania tokenów, w przeciwnym razie zwróci niezdefiniowane z odpowiedzi.

function getIdToken(): undefined | string

Zwraca

undefined | string

Token identyfikatora konta.

signOut()

Ta metoda wyzwala operację wylogowania, która usuwa informacje o bieżącym koncie i jego tokeny z pamięci podręcznej przeglądarki. Jeśli wyloguj się pomyślnie, przekierowuj stronę do adresu postLogoutRedirectUri, jeśli zostanie podana w konfiguracji.

function signOut(): Promise<SignOutResult>

Zwraca

Promise<SignOutResult>

Wynik operacji SignOut.