Class Tokens

Hierarchy

Tokens

Properties

`Private` `Optional` accessToken

accessToken?: string = null

`Private` accessTokenCookieName

accessTokenCookieName: string = ...

`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

GetAccessToken(): string
Manage Access Tokens

Returns string
- Defined in api/Tokens.ts:62

GetIdentityToken

GetIdentityToken(): string
Manage Identity Tokens

Returns string
- Defined in api/Tokens.ts:128

GetImpersonationToken

GetImpersonationToken(): string
Manage Impersonation Tokens

Returns string
- Defined in api/Tokens.ts:83

GetRefreshToken

GetRefreshToken(): string
Manage Refresh Tokens

Returns string
- Defined in api/Tokens.ts:106

GetValidToken

GetValidToken(tokenToValidate?: string): Promise<string>
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>
- Defined in api/Tokens.ts:151

RemoveAccessToken

RemoveAccessToken(): void
Returns void
- Defined in api/Tokens.ts:73

RemoveIdentityToken

RemoveIdentityToken(): void
Returns void
- Defined in api/Tokens.ts:140

RemoveImpersonationToken

RemoveImpersonationToken(): void
Returns void
- Defined in api/Tokens.ts:96

RemoveRefreshToken

RemoveRefreshToken(): void
Returns void
- Defined in api/Tokens.ts:118

SetAccessToken

SetAccessToken(token: string): void
Parameters
- token: string
Returns void
- Defined in api/Tokens.ts:66

SetIdentityToken

SetIdentityToken(token: string): void
Parameters
- token: string
Returns void
- Defined in api/Tokens.ts:134

SetImpersonationToken

SetImpersonationToken(token: string): void
Parameters
- token: string
Returns void
- Defined in api/Tokens.ts:89

SetRefreshToken

SetRefreshToken(token: string): void
Parameters
- token: string
Returns void
- Defined in api/Tokens.ts:112

`Private` _isTokenExpired

_isTokenExpired(token: string): boolean
Parameters
- token: string
Returns boolean
- Defined in api/Tokens.ts:159

`Private` _tryRefreshToken

_tryRefreshToken(accessToken: string): Promise<string>
Parameters
- accessToken: string
Returns Promise<string>
- Defined in api/Tokens.ts:169

Generated using TypeDoc