CacheHelpers module

Package:

@azure/msal-common

Functions

createAccessTokenEntity(string, string, string, string, string, string, number, number, (input: string) => string, number, AuthenticationScheme, string, string, string, string)	Create AccessTokenEntity
createIdTokenEntity(string, string, string, string, string)	Create IdTokenEntity
createRefreshTokenEntity(string, string, string, string, string, string, number)	Create RefreshTokenEntity
generateAppMetadataKey(AppMetadataEntity)	Generate AppMetadata Cache Key as per the schema: appmetadata-<environment>-<client_id>
generateAuthorityMetadataExpiresAt()	Reset the exiresAt value
isAccessTokenEntity(object)	Validates an entity: checks for all expected params
isAppMetadataEntity(string, object)
isAuthorityMetadataEntity(string, object)	Validates an entity: checks for all expected params
isAuthorityMetadataExpired(AuthorityMetadataEntity)	Returns whether or not the data needs to be refreshed
isCredentialEntity(object)
isIdTokenEntity(object)	Validates an entity: checks for all expected params
isRefreshTokenEntity(object)	Validates an entity: checks for all expected params
isServerTelemetryEntity(string, object)	validates if a given cache entry is "Telemetry", parses <key,value>
isThrottlingEntity(string, object)	validates if a given cache entry is "Throttling", parses <key,value>
updateAuthorityEndpointMetadata(AuthorityMetadataEntity, OpenIdConfigResponse, boolean)
updateCloudDiscoveryMetadata(AuthorityMetadataEntity, CloudDiscoveryMetadata, boolean)

Function Details

createAccessTokenEntity(string, string, string, string, string, string, number, number, (input: string) => string, number, AuthenticationScheme, string, string, string, string)

Create AccessTokenEntity

function createAccessTokenEntity(homeAccountId: string, environment: string, accessToken: string, clientId: string, tenantId: string, scopes: string, expiresOn: number, extExpiresOn: number, base64Decode: (input: string) => string, refreshOn?: number, tokenType?: AuthenticationScheme, userAssertionHash?: string, keyId?: string, requestedClaims?: string, requestedClaimsHash?: string): AccessTokenEntity

Parameters

homeAccountId

string

environment

string

accessToken

string

clientId

string

tenantId

string

scopes

string

expiresOn

number

extExpiresOn

number

base64Decode

(input: string) => string

refreshOn

number

tokenType

AuthenticationScheme

userAssertionHash

string

keyId

string

requestedClaims

string

requestedClaimsHash

string

Returns

AccessTokenEntity

createIdTokenEntity(string, string, string, string, string)

Create IdTokenEntity

function createIdTokenEntity(homeAccountId: string, environment: string, idToken: string, clientId: string, tenantId: string): IdTokenEntity

Parameters

homeAccountId

string

environment

string

idToken

string

clientId

string

tenantId

string

Returns

IdTokenEntity

createRefreshTokenEntity(string, string, string, string, string, string, number)

Create RefreshTokenEntity

function createRefreshTokenEntity(homeAccountId: string, environment: string, refreshToken: string, clientId: string, familyId?: string, userAssertionHash?: string, expiresOn?: number): RefreshTokenEntity

Parameters

homeAccountId

string

environment

string

refreshToken

string

clientId

string

familyId

string

userAssertionHash

string

expiresOn

number

Returns

RefreshTokenEntity

generateAppMetadataKey(AppMetadataEntity)

Generate AppMetadata Cache Key as per the schema: appmetadata-<environment>-<client_id>

function generateAppMetadataKey(__namedParameters: AppMetadataEntity): string

Parameters

__namedParameters

AppMetadataEntity

Returns

string

generateAuthorityMetadataExpiresAt()

Reset the exiresAt value

function generateAuthorityMetadataExpiresAt(): number

Returns

number

isAccessTokenEntity(object)

Validates an entity: checks for all expected params

function isAccessTokenEntity(entity: object): entity

Parameters

entity

object

Returns

entity

isAppMetadataEntity(string, object)

function isAppMetadataEntity(key: string, entity: object): boolean

Parameters

key

string

entity

object

Returns

boolean

isAuthorityMetadataEntity(string, object)

Validates an entity: checks for all expected params

function isAuthorityMetadataEntity(key: string, entity: object): boolean

Parameters

key

string

entity

object

Returns

boolean

isAuthorityMetadataExpired(AuthorityMetadataEntity)

Returns whether or not the data needs to be refreshed

function isAuthorityMetadataExpired(metadata: AuthorityMetadataEntity): boolean

Parameters

metadata

AuthorityMetadataEntity

Returns

boolean

isCredentialEntity(object)

function isCredentialEntity(entity: object): entity

Parameters

entity

object

Returns

entity

isIdTokenEntity(object)

Validates an entity: checks for all expected params

function isIdTokenEntity(entity: object): entity

Parameters

entity

object

Returns

entity

isRefreshTokenEntity(object)

Validates an entity: checks for all expected params

function isRefreshTokenEntity(entity: object): entity

Parameters

entity

object

Returns

entity

isServerTelemetryEntity(string, object)

validates if a given cache entry is "Telemetry", parses <key,value>

function isServerTelemetryEntity(key: string, entity?: object): boolean

Parameters

key

string

entity

object

Returns

boolean

isThrottlingEntity(string, object)

validates if a given cache entry is "Throttling", parses <key,value>

function isThrottlingEntity(key: string, entity?: object): boolean

Parameters

key

string

entity

object

Returns

boolean

updateAuthorityEndpointMetadata(AuthorityMetadataEntity, OpenIdConfigResponse, boolean)

function updateAuthorityEndpointMetadata(authorityMetadata: AuthorityMetadataEntity, updatedValues: OpenIdConfigResponse, fromNetwork: boolean)

Parameters

authorityMetadata

AuthorityMetadataEntity

updatedValues

OpenIdConfigResponse

fromNetwork

boolean

updateCloudDiscoveryMetadata(AuthorityMetadataEntity, CloudDiscoveryMetadata, boolean)

function updateCloudDiscoveryMetadata(authorityMetadata: AuthorityMetadataEntity, updatedValues: CloudDiscoveryMetadata, fromNetwork: boolean)

Parameters

authorityMetadata

AuthorityMetadataEntity

updatedValues

CloudDiscoveryMetadata

fromNetwork

boolean