CustomAuthAccountData class

Balíček:

@azure/msal-browser

Konstruktory

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

Metody

getAccessToken(AccessTokenRetrievalInputs)	Získá přístupový token aktuálního účtu z mezipaměti prohlížeče, pokud nevypršela jeho platnost, v opačném případě obnovte token pomocí obnovovacího tokenu v mezipaměti, pokud je platný. Pokud se nenajde žádný obnovovací token nebo vypršela jeho platnost, dojde k chybě.
getAccount()
getClaims()	Získá deklarace identity tokenu ID extrahované z nezpracovaného IdToken aktuálního účtu.
getIdToken()	Získá nezpracovaný id-token aktuálního účtu. Idtoken se vydává pouze v případě, že je v parametru scopes k dispozici rozsah openid při žádosti o tokeny, jinak se vrátí nedefinovaný z odpovědi.
signOut()	Tato metoda aktivuje operaci odhlášení, která odebere aktuální informace o účtu a jeho tokeny z mezipaměti prohlížeče. Pokud se odhlašování úspěšně odhlásí, přesměrujte stránku na postLogoutRedirectUri, pokud je uvedená v konfiguraci.

Podrobnosti konstruktoru

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

Podrobnosti metody

getAccessToken(AccessTokenRetrievalInputs)

Získá přístupový token aktuálního účtu z mezipaměti prohlížeče, pokud nevypršela jeho platnost, v opačném případě obnovte token pomocí obnovovacího tokenu v mezipaměti, pokud je platný. Pokud se nenajde žádný obnovovací token nebo vypršela jeho platnost, dojde k chybě.

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

Parametry

accessTokenRetrievalInputs

AccessTokenRetrievalInputs

Vstupy pro načtení přístupového tokenu.

Návraty

Promise<GetAccessTokenResult>

Výsledek operace.

getAccount()

function getAccount(): AccountInfo

Návraty

AccountInfo

getClaims()

Získá deklarace identity tokenu ID extrahované z nezpracovaného IdToken aktuálního účtu.

function getClaims(): undefined | AuthTokenClaims

Návraty

undefined | AuthTokenClaims

Deklarace identity tokenu.

getIdToken()

Získá nezpracovaný id-token aktuálního účtu. Idtoken se vydává pouze v případě, že je v parametru scopes k dispozici rozsah openid při žádosti o tokeny, jinak se vrátí nedefinovaný z odpovědi.

function getIdToken(): undefined | string

Návraty

undefined | string

Id-token účtu.

signOut()

Tato metoda aktivuje operaci odhlášení, která odebere aktuální informace o účtu a jeho tokeny z mezipaměti prohlížeče. Pokud se odhlašování úspěšně odhlásí, přesměrujte stránku na postLogoutRedirectUri, pokud je uvedená v konfiguraci.

function signOut(): Promise<SignOutResult>

Návraty

Promise<SignOutResult>

Výsledek operace SignOut.