CustomAuthAccountData class

Методы

getAccessToken(AccessTokenRetrievalInputs)

Возвращает маркер доступа текущей учетной записи из кэша браузера, если срок действия не истек, в противном случае обновите маркер с использованием кэшированного маркера обновления, если он действителен. Если маркер обновления не найден или истек, возникает ошибка.

getAccount()
getClaims()

Возвращает утверждения маркера идентификатора, извлеченные из необработанного IdToken текущей учетной записи.

getIdToken()

Возвращает необработанный маркер идентификатора текущей учетной записи. Idtoken выдается только в том случае, если область openid присутствует в параметре областей при запросе маркеров, в противном случае возвращается не определено из ответа.

signOut()

Этот метод запускает операцию выхода, которая удаляет сведения о текущей учетной записи и его маркеры из кэша браузера. При успешном выходе перенаправьте страницу на postLogoutRedirectUri, если она указана в конфигурации.

Сведения о конструкторе

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

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

Параметры

account
AccountInfo
config

CustomAuthBrowserConfiguration

cacheClient

CustomAuthSilentCacheClient

logger
Logger
correlationId

string

Сведения о методе

getAccessToken(AccessTokenRetrievalInputs)

Возвращает маркер доступа текущей учетной записи из кэша браузера, если срок действия не истек, в противном случае обновите маркер с использованием кэшированного маркера обновления, если он действителен. Если маркер обновления не найден или истек, возникает ошибка.

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

Параметры

accessTokenRetrievalInputs
AccessTokenRetrievalInputs

Входные данные для получения маркера доступа.

Возвращаемое значение

Результат операции.

getAccount()

function getAccount(): AccountInfo

Возвращаемое значение

getClaims()

Возвращает утверждения маркера идентификатора, извлеченные из необработанного IdToken текущей учетной записи.

function getClaims(): undefined | AuthTokenClaims

Возвращаемое значение

undefined | AuthTokenClaims

Утверждения маркера.

getIdToken()

Возвращает необработанный маркер идентификатора текущей учетной записи. Idtoken выдается только в том случае, если область openid присутствует в параметре областей при запросе маркеров, в противном случае возвращается не определено из ответа.

function getIdToken(): undefined | string

Возвращаемое значение

undefined | string

Маркер идентификатора учетной записи.

signOut()

Этот метод запускает операцию выхода, которая удаляет сведения о текущей учетной записи и его маркеры из кэша браузера. При успешном выходе перенаправьте страницу на postLogoutRedirectUri, если она указана в конфигурации.

function signOut(): Promise<SignOutResult>

Возвращаемое значение

Promise<SignOutResult>

Результат операции SignOut.