Class Tokens

Hierarchy

  • Tokens

Properties

accessToken? accessTokenCookieName identityProviderAccessToken? identityProviderAccessTokenCookieName identityToken? identityTokenCookieName impersonationToken? impersonationTokenCookieName refreshToken? refreshTokenCookieName

Methods

GetAccessToken GetIdentityToken GetIdpAccessToken GetImpersonationToken GetRefreshToken GetValidToken RemoveAccessToken RemoveIdentityToken RemoveIdpAccessToken RemoveImpersonationToken RemoveRefreshToken SetAccessToken SetIdentityToken SetIdpAccessToken SetImpersonationToken SetRefreshToken _isTokenExpired _tryRefreshToken

Properties

Private Optional accessToken

accessToken?: string = null

Private accessTokenCookieName

accessTokenCookieName: string = ...

Private Optional identityProviderAccessToken

identityProviderAccessToken?: string = null

Private identityProviderAccessTokenCookieName

identityProviderAccessTokenCookieName: string = '.idp-access-token'

Private Optional identityToken

identityToken?: string = null

Private identityTokenCookieName

identityTokenCookieName: string = '.identity-token'

Private Optional impersonationToken

impersonationToken?: string = null

Private impersonationTokenCookieName

impersonationTokenCookieName: string = '.impersonation-token'

Private Optional refreshToken

refreshToken?: string = null

Private refreshTokenCookieName

refreshTokenCookieName: string = '.refresh-token'

Methods

GetAccessToken

  • Manage Access Tokens

    Returns string

GetIdentityToken

  • Manage Identity Tokens

    Returns string

GetIdpAccessToken

  • Manage Identity Provider Tokens

    Returns string

GetImpersonationToken

  • Manage Impersonation Tokens

    Returns string

GetRefreshToken

  • Manage Refresh Tokens

    Returns string

GetValidToken

  • If no token is provided will attempt to get and validate token stored in sdk. If token is invalid or missing it will also attempt to refresh the token if possible

    Parameters

    • Optional tokenToValidate: string

    Returns Promise<string>

RemoveAccessToken

RemoveIdentityToken

RemoveIdpAccessToken

RemoveImpersonationToken

RemoveRefreshToken

SetAccessToken

  • Parameters

    • token: string

    Returns void

SetIdentityToken

  • Parameters

    • token: string

    Returns void

SetIdpAccessToken

  • Parameters

    • token: string

    Returns void

SetImpersonationToken

  • Parameters

    • token: string

    Returns void

SetRefreshToken

  • Parameters

    • token: string

    Returns void

Private _isTokenExpired

  • _isTokenExpired(token: string): boolean

  • Parameters

    • token: string

    Returns boolean

Private _tryRefreshToken

  • _tryRefreshToken(accessToken: string): Promise<string>

  • Parameters

    • accessToken: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc