CustomAuthAccountData class

Methoden

getAccessToken(AccessTokenRetrievalInputs)

Ruft das Zugriffstoken des aktuellen Kontos aus dem Browsercache ab, wenn es nicht abgelaufen ist, andernfalls erneuern Sie das Token mithilfe des zwischengespeicherten Aktualisierungstokens, falls gültig. Wenn kein Aktualisierungstoken gefunden oder abgelaufen ist, wird ein Fehler ausgelöst.

getAccount()
getClaims()

Ruft die id-Tokenansprüche ab, die aus dem rohen IdToken des aktuellen Kontos extrahiert wurden.

getIdToken()

Ruft das rohe ID-Token des aktuellen Kontos ab. Idtoken wird nur ausgegeben, wenn der OpenID-Bereich beim Anfordern von Token im Bereichsparameter vorhanden ist, andernfalls wird von der Antwort nicht definiert zurückgegeben.

signOut()

Diese Methode löst einen Abmeldevorgang aus, der die aktuellen Kontoinformationen und die zugehörigen Token aus dem Browsercache entfernt. Wenn die Abmeldung erfolgreich war, leiten Sie die Seite an postLogoutRedirectUri um, wenn sie in der Konfiguration angegeben ist.

Details zum Konstruktor

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

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

Parameter

account
AccountInfo
config

CustomAuthBrowserConfiguration

cacheClient

CustomAuthSilentCacheClient

logger
Logger
correlationId

string

Details zur Methode

getAccessToken(AccessTokenRetrievalInputs)

Ruft das Zugriffstoken des aktuellen Kontos aus dem Browsercache ab, wenn es nicht abgelaufen ist, andernfalls erneuern Sie das Token mithilfe des zwischengespeicherten Aktualisierungstokens, falls gültig. Wenn kein Aktualisierungstoken gefunden oder abgelaufen ist, wird ein Fehler ausgelöst.

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

Parameter

accessTokenRetrievalInputs
AccessTokenRetrievalInputs

Die Eingaben zum Abrufen des Zugriffstokens.

Gibt zurück

Das Ergebnis des Vorgangs.

getAccount()

function getAccount(): AccountInfo

Gibt zurück

getClaims()

Ruft die id-Tokenansprüche ab, die aus dem rohen IdToken des aktuellen Kontos extrahiert wurden.

function getClaims(): undefined | AuthTokenClaims

Gibt zurück

undefined | AuthTokenClaims

Die Tokenansprüche.

getIdToken()

Ruft das rohe ID-Token des aktuellen Kontos ab. Idtoken wird nur ausgegeben, wenn der OpenID-Bereich beim Anfordern von Token im Bereichsparameter vorhanden ist, andernfalls wird von der Antwort nicht definiert zurückgegeben.

function getIdToken(): undefined | string

Gibt zurück

undefined | string

Das Konto-ID-Token.

signOut()

Diese Methode löst einen Abmeldevorgang aus, der die aktuellen Kontoinformationen und die zugehörigen Token aus dem Browsercache entfernt. Wenn die Abmeldung erfolgreich war, leiten Sie die Seite an postLogoutRedirectUri um, wenn sie in der Konfiguration angegeben ist.

function signOut(): Promise<SignOutResult>

Gibt zurück

Promise<SignOutResult>

Das Ergebnis des SignOut-Vorgangs.