recipe/session | supertokens-node

Type Aliases

APIInterface

APIInterface: { refreshPOST: undefined | ((input: { options: APIOptions; userContext: UserContext }) => Promise<SessionContainer>); signOutPOST: undefined | ((input: { options: APIOptions; session: SessionContainer; userContext: UserContext }) => Promise<{ status: "OK" } | GeneralErrorResponse>); verifySession: any }

Type declaration

refreshPOST: undefined | ((input: { options: APIOptions; userContext: UserContext }) => Promise<SessionContainer>)

We do not add a GeneralErrorResponse response to this API since it's not something that is directly called by the user on the frontend anyway
signOutPOST: undefined | ((input: { options: APIOptions; session: SessionContainer; userContext: UserContext }) => Promise<{ status: "OK" } | GeneralErrorResponse>)
verifySession:function
- verifySession(input: { options: APIOptions; userContext: UserContext; verifySessionOptions: VerifySessionOptions | undefined }): Promise<undefined | SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:432
  Parameters
  - input: { options: APIOptions; userContext: UserContext; verifySessionOptions: VerifySessionOptions | undefined }
    - options: APIOptions
    - userContext: UserContext
    - verifySessionOptions: VerifySessionOptions | undefined
  Returns Promise<undefined | SessionContainer>

APIOptions

APIOptions: { config: TypeNormalisedInput; isInServerlessEnv: boolean; recipeId: string; recipeImplementation: RecipeInterface; req: BaseRequest; res: BaseResponse }

Type declaration

config: TypeNormalisedInput
isInServerlessEnv: boolean
recipeId: string
recipeImplementation: RecipeInterface
req: BaseRequest
res: BaseResponse

RecipeInterface

RecipeInterface: { createNewSession: any; fetchAndSetClaim: any; getAllSessionHandlesForUser: any; getClaimValue: any; getGlobalClaimValidators: any; getSession: any; getSessionInformation: any; mergeIntoAccessTokenPayload: any; refreshSession: any; regenerateAccessToken: any; removeClaim: any; revokeAllSessionsForUser: any; revokeMultipleSessions: any; revokeSession: any; setClaimValue: any; updateSessionDataInDatabase: any; validateClaims: any }

Type declaration

createNewSession:function
- createNewSession(input: { accessTokenPayload?: any; disableAntiCsrf?: boolean; recipeUserId: RecipeUserId; sessionDataInDatabase?: any; tenantId: string; userContext: UserContext; userId: string }): Promise<SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:214
  Parameters
  - input: { accessTokenPayload?: any; disableAntiCsrf?: boolean; recipeUserId: RecipeUserId; sessionDataInDatabase?: any; tenantId: string; userContext: UserContext; userId: string }
    - Optional accessTokenPayload?: any
    - Optional disableAntiCsrf?: boolean
    - recipeUserId: RecipeUserId
    - Optional sessionDataInDatabase?: any
    - tenantId: string
    - userContext: UserContext
    - userId: string
  Returns Promise<SessionContainer>
fetchAndSetClaim:function
- fetchAndSetClaim(input: { claim: SessionClaim<any>; sessionHandle: string; userContext: UserContext }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:327
  Parameters
  - input: { claim: SessionClaim<any>; sessionHandle: string; userContext: UserContext }
    - claim: SessionClaim<any>
    - sessionHandle: string
    - userContext: UserContext
  Returns Promise<boolean>
getAllSessionHandlesForUser:function
- getAllSessionHandlesForUser(input: { fetchAcrossAllTenants?: boolean; fetchSessionsForAllLinkedAccounts: boolean; tenantId: string; userContext: UserContext; userId: string }): Promise<string[]>
- - Defined in lib/ts/recipe/session/types.ts:266
  Parameters
  - input: { fetchAcrossAllTenants?: boolean; fetchSessionsForAllLinkedAccounts: boolean; tenantId: string; userContext: UserContext; userId: string }
    - Optional fetchAcrossAllTenants?: boolean
    - fetchSessionsForAllLinkedAccounts: boolean
    - tenantId: string
    - userContext: UserContext
    - userId: string
  Returns Promise<string[]>
getClaimValue:function
- getClaimValue<T>(input: { claim: SessionClaim<T>; sessionHandle: string; userContext: UserContext }): Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: T | undefined }>
- - Defined in lib/ts/recipe/session/types.ts:339
  Type Parameters
  - T
  Parameters
  - input: { claim: SessionClaim<T>; sessionHandle: string; userContext: UserContext }
    - claim: SessionClaim<T>
    - sessionHandle: string
    - userContext: UserContext
  Returns Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: T | undefined }>
getGlobalClaimValidators:function
- getGlobalClaimValidators(input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext; userId: string }): SessionClaimValidator[] | Promise<SessionClaimValidator[]>
- - Defined in lib/ts/recipe/session/types.ts:224
  Parameters
  - input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext; userId: string }
    - claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]
    - recipeUserId: RecipeUserId
    - tenantId: string
    - userContext: UserContext
    - userId: string
  Returns SessionClaimValidator[] | Promise<SessionClaimValidator[]>
getSession:function
- getSession(input: { accessToken: string | undefined; antiCsrfToken?: string; options?: VerifySessionOptions; userContext: UserContext }): Promise<undefined | SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:232
  Parameters
  - input: { accessToken: string | undefined; antiCsrfToken?: string; options?: VerifySessionOptions; userContext: UserContext }
    - accessToken: string | undefined
    - Optional antiCsrfToken?: string
    - Optional options?: VerifySessionOptions
    - userContext: UserContext
  Returns Promise<undefined | SessionContainer>
getSessionInformation:function
- getSessionInformation(input: { sessionHandle: string; userContext: UserContext }): Promise<undefined | SessionInformation>
- - Defined in lib/ts/recipe/session/types.ts:253
  Used to retrieve all session information for a given session handle. Can be used in place of:
  - getSessionDataFromDatabase
  - getAccessTokenPayload
  Returns undefined if the sessionHandle does not exist
  Parameters
  - input: { sessionHandle: string; userContext: UserContext }
    - sessionHandle: string
    - userContext: UserContext
  Returns Promise<undefined | SessionInformation>
mergeIntoAccessTokenPayload:function
- mergeIntoAccessTokenPayload(input: { accessTokenPayloadUpdate: JSONObject; sessionHandle: string; userContext: UserContext }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:285
  Parameters
  - input: { accessTokenPayloadUpdate: JSONObject; sessionHandle: string; userContext: UserContext }
    - accessTokenPayloadUpdate: JSONObject
    - sessionHandle: string
    - userContext: UserContext
  Returns Promise<boolean>
refreshSession:function
- refreshSession(input: { antiCsrfToken?: string; disableAntiCsrf: boolean; refreshToken: string; userContext: UserContext }): Promise<SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:239
  Parameters
  - input: { antiCsrfToken?: string; disableAntiCsrf: boolean; refreshToken: string; userContext: UserContext }
    - Optional antiCsrfToken?: string
    - disableAntiCsrf: boolean
    - refreshToken: string
    - userContext: UserContext
  Returns Promise<SessionContainer>
regenerateAccessToken:function
- regenerateAccessToken(input: { accessToken: string; newAccessTokenPayload?: any; userContext: UserContext }): Promise<undefined | { accessToken?: { createdTime: number; expiry: number; token: string }; session: { handle: string; recipeUserId: RecipeUserId; tenantId: string; userDataInJWT: any; userId: string }; status: "OK" }>
- - Defined in lib/ts/recipe/session/types.ts:294
  Parameters
  - input: { accessToken: string; newAccessTokenPayload?: any; userContext: UserContext }
    - accessToken: string
    - Optional newAccessTokenPayload?: any
    - userContext: UserContext
  Returns Promise<undefined | { accessToken?: { createdTime: number; expiry: number; token: string }; session: { handle: string; recipeUserId: RecipeUserId; tenantId: string; userDataInJWT: any; userId: string }; status: "OK" }>
  Returns false if the sessionHandle does not exist
removeClaim:function
- removeClaim(input: { claim: SessionClaim<any>; sessionHandle: string; userContext: UserContext }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:353
  Parameters
  - input: { claim: SessionClaim<any>; sessionHandle: string; userContext: UserContext }
    - claim: SessionClaim<any>
    - sessionHandle: string
    - userContext: UserContext
  Returns Promise<boolean>
revokeAllSessionsForUser:function
- revokeAllSessionsForUser(input: { revokeAcrossAllTenants?: boolean; revokeSessionsForLinkedAccounts: boolean; tenantId: string; userContext: UserContext; userId: string }): Promise<string[]>
- - Defined in lib/ts/recipe/session/types.ts:258
  Parameters
  - input: { revokeAcrossAllTenants?: boolean; revokeSessionsForLinkedAccounts: boolean; tenantId: string; userContext: UserContext; userId: string }
    - Optional revokeAcrossAllTenants?: boolean
    - revokeSessionsForLinkedAccounts: boolean
    - tenantId: string
    - userContext: UserContext
    - userId: string
  Returns Promise<string[]>
revokeMultipleSessions:function
- revokeMultipleSessions(input: { sessionHandles: string[]; userContext: UserContext }): Promise<string[]>
- - Defined in lib/ts/recipe/session/types.ts:276
  Parameters
  - input: { sessionHandles: string[]; userContext: UserContext }
    - sessionHandles: string[]
    - userContext: UserContext
  Returns Promise<string[]>
revokeSession:function
- revokeSession(input: { sessionHandle: string; userContext: UserContext }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:274
  Parameters
  - input: { sessionHandle: string; userContext: UserContext }
    - sessionHandle: string
    - userContext: UserContext
  Returns Promise<boolean>
setClaimValue:function
- setClaimValue<T>(input: { claim: SessionClaim<T>; sessionHandle: string; userContext: UserContext; value: T }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:332
  Type Parameters
  - T
  Parameters
  - input: { claim: SessionClaim<T>; sessionHandle: string; userContext: UserContext; value: T }
    - claim: SessionClaim<T>
    - sessionHandle: string
    - userContext: UserContext
    - value: T
  Returns Promise<boolean>
updateSessionDataInDatabase:function
- updateSessionDataInDatabase(input: { newSessionData: any; sessionHandle: string; userContext: UserContext }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:279
  Parameters
  - input: { newSessionData: any; sessionHandle: string; userContext: UserContext }
    - newSessionData: any
    - sessionHandle: string
    - userContext: UserContext
  Returns Promise<boolean>
validateClaims:function
- validateClaims(input: { accessTokenPayload: any; claimValidators: SessionClaimValidator[]; recipeUserId: RecipeUserId; userContext: UserContext; userId: string }): Promise<{ accessTokenPayloadUpdate?: any; invalidClaims: ClaimValidationError[] }>
- - Defined in lib/ts/recipe/session/types.ts:317
  Parameters
  - input: { accessTokenPayload: any; claimValidators: SessionClaimValidator[]; recipeUserId: RecipeUserId; userContext: UserContext; userId: string }
    - accessTokenPayload: any
    - claimValidators: SessionClaimValidator[]
    - recipeUserId: RecipeUserId
    - userContext: UserContext
    - userId: string
  Returns Promise<{ accessTokenPayloadUpdate?: any; invalidClaims: ClaimValidationError[] }>

SessionClaimValidator

SessionClaimValidator: ({ claim: SessionClaim<any>; shouldRefetch: any } | {}) & { id: string; validate: any }

SessionInformation

SessionInformation: { customClaimsInAccessTokenPayload: any; expiry: number; recipeUserId: RecipeUserId; sessionDataInDatabase: any; sessionHandle: string; tenantId: string; timeCreated: number; userId: string }

Type declaration

customClaimsInAccessTokenPayload: any
expiry: number
recipeUserId: RecipeUserId
sessionDataInDatabase: any
sessionHandle: string
tenantId: string
timeCreated: number
userId: string

Variables

Error

Error: typeof default = SessionWrapper.Error

Functions

createJWT

createJWT(payload?: any, validitySeconds?: number, useStaticSigningKey?: boolean, userContext?: Record<string, any>): Promise<{ jwt: string; status: "OK" } | { status: "UNSUPPORTED_ALGORITHM_ERROR" }>

- Defined in lib/ts/recipe/session/index.ts:514
Parameters
- Optional payload: any
- Optional validitySeconds: number
- Optional useStaticSigningKey: boolean
- Optional userContext: Record<string, any>
Returns Promise<{ jwt: string; status: "OK" } | { status: "UNSUPPORTED_ALGORITHM_ERROR" }>

createNewSession

createNewSession(req: any, res: any, tenantId: string, recipeUserId: RecipeUserId, accessTokenPayload?: any, sessionDataInDatabase?: any, userContext?: Record<string, any>): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:482
Parameters
- req: any
- res: any
- tenantId: string
- recipeUserId: RecipeUserId
- accessTokenPayload: any = {}
- sessionDataInDatabase: any = {}
- Optional userContext: Record<string, any>
Returns Promise<SessionContainer>

createNewSessionWithoutRequestResponse

createNewSessionWithoutRequestResponse(tenantId: string, recipeUserId: RecipeUserId, accessTokenPayload?: any, sessionDataInDatabase?: any, disableAntiCsrf?: boolean, userContext?: Record<string, any>): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:483
Parameters
- tenantId: string
- recipeUserId: RecipeUserId
- accessTokenPayload: any = {}
- sessionDataInDatabase: any = {}
- disableAntiCsrf: boolean = false
- Optional userContext: Record<string, any>
Returns Promise<SessionContainer>

fetchAndSetClaim

fetchAndSetClaim(sessionHandle: string, claim: SessionClaim<any>, userContext?: Record<string, any>): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:505
Parameters
- sessionHandle: string
- claim: SessionClaim<any>
- Optional userContext: Record<string, any>
Returns Promise<boolean>

getAllSessionHandlesForUser

getAllSessionHandlesForUser(userId: string, fetchSessionsForAllLinkedAccounts?: boolean, tenantId?: string, userContext?: Record<string, any>): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:495
Parameters
- userId: string
- fetchSessionsForAllLinkedAccounts: boolean = true
- Optional tenantId: string
- Optional userContext: Record<string, any>
Returns Promise<string[]>

getClaimValue

getClaimValue<T>(sessionHandle: string, claim: SessionClaim<T>, userContext?: Record<string, any>): Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: undefined | T }>

- Defined in lib/ts/recipe/session/index.ts:507
Type Parameters
- T
Parameters
- sessionHandle: string
- claim: SessionClaim<T>
- Optional userContext: Record<string, any>
Returns Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: undefined | T }>

getJWKS

getJWKS(userContext?: Record<string, any>): Promise<{ keys: JsonWebKey[] }>

- Defined in lib/ts/recipe/session/index.ts:516
Parameters
- Optional userContext: Record<string, any>
Returns Promise<{ keys: JsonWebKey[] }>

getOpenIdDiscoveryConfiguration

getOpenIdDiscoveryConfiguration(userContext?: Record<string, any>): Promise<{ issuer: string; jwks_uri: string; status: "OK" }>

- Defined in lib/ts/recipe/session/index.ts:520
Parameters
- Optional userContext: Record<string, any>
Returns Promise<{ issuer: string; jwks_uri: string; status: "OK" }>

getSession

getSession(req: any, res: any): Promise<SessionContainer>
getSession(req: any, res: any, options?: VerifySessionOptions & { sessionRequired?: true }, userContext?: Record<string, any>): Promise<SessionContainer>
getSession(req: any, res: any, options?: VerifySessionOptions & { sessionRequired: false }, userContext?: Record<string, any>): Promise<undefined | SessionContainer>
getSession(req: any, res: any, options?: VerifySessionOptions, userContext?: Record<string, any>): Promise<undefined | SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:485
Parameters
- req: any
- res: any
Returns Promise<SessionContainer>
- Defined in lib/ts/recipe/session/index.ts:485
Parameters
- req: any
- res: any
- Optional options: VerifySessionOptions & { sessionRequired?: true }
- Optional userContext: Record<string, any>
Returns Promise<SessionContainer>
- Defined in lib/ts/recipe/session/index.ts:485
Parameters
- req: any
- res: any
- Optional options: VerifySessionOptions & { sessionRequired: false }
- Optional userContext: Record<string, any>
Returns Promise<undefined | SessionContainer>
- Defined in lib/ts/recipe/session/index.ts:485
Parameters
- req: any
- res: any
- Optional options: VerifySessionOptions
- Optional userContext: Record<string, any>
Returns Promise<undefined | SessionContainer>

getSessionInformation

getSessionInformation(sessionHandle: string, userContext?: Record<string, any>): Promise<undefined | SessionInformation>

- Defined in lib/ts/recipe/session/index.ts:488
Parameters
- sessionHandle: string
- Optional userContext: Record<string, any>
Returns Promise<undefined | SessionInformation>

getSessionWithoutRequestResponse

getSessionWithoutRequestResponse(accessToken: string, antiCsrfToken?: string): Promise<SessionContainer>
getSessionWithoutRequestResponse(accessToken: string, antiCsrfToken?: string, options?: VerifySessionOptions & { sessionRequired?: true }, userContext?: Record<string, any>): Promise<SessionContainer>
getSessionWithoutRequestResponse(accessToken: string, antiCsrfToken?: string, options?: VerifySessionOptions & { sessionRequired: false }, userContext?: Record<string, any>): Promise<undefined | SessionContainer>
getSessionWithoutRequestResponse(accessToken: string, antiCsrfToken?: string, options?: VerifySessionOptions, userContext?: Record<string, any>): Promise<undefined | SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:486
Parameters
- accessToken: string
- Optional antiCsrfToken: string
Returns Promise<SessionContainer>
- Defined in lib/ts/recipe/session/index.ts:486
Parameters
- accessToken: string
- Optional antiCsrfToken: string
- Optional options: VerifySessionOptions & { sessionRequired?: true }
- Optional userContext: Record<string, any>
Returns Promise<SessionContainer>
- Defined in lib/ts/recipe/session/index.ts:486
Parameters
- accessToken: string
- Optional antiCsrfToken: string
- Optional options: VerifySessionOptions & { sessionRequired: false }
- Optional userContext: Record<string, any>
Returns Promise<undefined | SessionContainer>
- Defined in lib/ts/recipe/session/index.ts:486
Parameters
- accessToken: string
- Optional antiCsrfToken: string
- Optional options: VerifySessionOptions
- Optional userContext: Record<string, any>
Returns Promise<undefined | SessionContainer>

init

init(config?: TypeInput): RecipeListFunction

- Defined in lib/ts/recipe/session/index.ts:480
Parameters
- Optional config: TypeInput
Returns RecipeListFunction

mergeIntoAccessTokenPayload

mergeIntoAccessTokenPayload(sessionHandle: string, accessTokenPayloadUpdate: JSONObject, userContext?: Record<string, any>): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:503
Parameters
- sessionHandle: string
- accessTokenPayloadUpdate: JSONObject
- Optional userContext: Record<string, any>
Returns Promise<boolean>

refreshSession

refreshSession(req: any, res: any, userContext?: Record<string, any>): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:490
Parameters
- req: any
- res: any
- Optional userContext: Record<string, any>
Returns Promise<SessionContainer>

refreshSessionWithoutRequestResponse

refreshSessionWithoutRequestResponse(refreshToken: string, disableAntiCsrf?: boolean, antiCsrfToken?: string, userContext?: Record<string, any>): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:491
Parameters
- refreshToken: string
- disableAntiCsrf: boolean = false
- Optional antiCsrfToken: string
- Optional userContext: Record<string, any>
Returns Promise<SessionContainer>

removeClaim

removeClaim(sessionHandle: string, claim: SessionClaim<any>, userContext?: Record<string, any>): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:508
Parameters
- sessionHandle: string
- claim: SessionClaim<any>
- Optional userContext: Record<string, any>
Returns Promise<boolean>

revokeAllSessionsForUser

revokeAllSessionsForUser(userId: string, revokeSessionsForLinkedAccounts?: boolean, tenantId?: string, userContext?: Record<string, any>): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:493
Parameters
- userId: string
- revokeSessionsForLinkedAccounts: boolean = true
- Optional tenantId: string
- Optional userContext: Record<string, any>
Returns Promise<string[]>

revokeMultipleSessions

revokeMultipleSessions(sessionHandles: string[], userContext?: Record<string, any>): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:499
Parameters
- sessionHandles: string[]
- Optional userContext: Record<string, any>
Returns Promise<string[]>

revokeSession

revokeSession(sessionHandle: string, userContext?: Record<string, any>): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:497
Parameters
- sessionHandle: string
- Optional userContext: Record<string, any>
Returns Promise<boolean>

setClaimValue

setClaimValue<T>(sessionHandle: string, claim: SessionClaim<T>, value: T, userContext?: Record<string, any>): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:506
Type Parameters
- T
Parameters
- sessionHandle: string
- claim: SessionClaim<T>
- value: T
- Optional userContext: Record<string, any>
Returns Promise<boolean>

updateSessionDataInDatabase

updateSessionDataInDatabase(sessionHandle: string, newSessionData: any, userContext?: Record<string, any>): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:501
Parameters
- sessionHandle: string
- newSessionData: any
- Optional userContext: Record<string, any>
Returns Promise<boolean>

validateClaimsForSessionHandle

validateClaimsForSessionHandle(sessionHandle: string, overrideGlobalClaimValidators?: ((globalClaimValidators: SessionClaimValidator[], sessionInfo: SessionInformation, userContext: UserContext) => SessionClaimValidator[] | Promise<SessionClaimValidator[]>), userContext?: Record<string, any>): Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { invalidClaims: ClaimValidationError[]; status: "OK" }>

- Defined in lib/ts/recipe/session/index.ts:509
Parameters
- sessionHandle: string
- Optional overrideGlobalClaimValidators: ((globalClaimValidators: SessionClaimValidator[], sessionInfo: SessionInformation, userContext: UserContext) => SessionClaimValidator[] | Promise<SessionClaimValidator[]>)
  - - (globalClaimValidators: SessionClaimValidator[], sessionInfo: SessionInformation, userContext: UserContext): SessionClaimValidator[] | Promise<SessionClaimValidator[]>
    - Parameters
      - globalClaimValidators: SessionClaimValidator[]
      - sessionInfo: SessionInformation
      - userContext: UserContext
      Returns SessionClaimValidator[] | Promise<SessionClaimValidator[]>
- Optional userContext: Record<string, any>
Returns Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { invalidClaims: ClaimValidationError[]; status: "OK" }>

Index

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

APIInterface

Type declaration

refreshPOST: undefined | ((input: { options: APIOptions; userContext: UserContext }) => Promise<SessionContainer>)

signOutPOST: undefined | ((input: { options: APIOptions; session: SessionContainer; userContext: UserContext }) => Promise<{ status: "OK" } | GeneralErrorResponse>)

verifySession:function

Parameters

input: { options: APIOptions; userContext: UserContext; verifySessionOptions: VerifySessionOptions | undefined }

options: APIOptions

userContext: UserContext

verifySessionOptions: VerifySessionOptions | undefined

Returns Promise<undefined | SessionContainer>

APIOptions

Type declaration

config: TypeNormalisedInput

isInServerlessEnv: boolean

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

RecipeInterface

Type declaration

createNewSession:function

Parameters

input: { accessTokenPayload?: any; disableAntiCsrf?: boolean; recipeUserId: RecipeUserId; sessionDataInDatabase?: any; tenantId: string; userContext: UserContext; userId: string }

Optional accessTokenPayload?: any

Optional disableAntiCsrf?: boolean

recipeUserId: RecipeUserId

Optional sessionDataInDatabase?: any

tenantId: string

userContext: UserContext

userId: string

Returns Promise<SessionContainer>

fetchAndSetClaim:function

Parameters

input: { claim: SessionClaim<any>; sessionHandle: string; userContext: UserContext }

claim: SessionClaim<any>

sessionHandle: string

userContext: UserContext

Returns Promise<boolean>

getAllSessionHandlesForUser:function

Parameters

input: { fetchAcrossAllTenants?: boolean; fetchSessionsForAllLinkedAccounts: boolean; tenantId: string; userContext: UserContext; userId: string }

Optional fetchAcrossAllTenants?: boolean

fetchSessionsForAllLinkedAccounts: boolean

tenantId: string

userContext: UserContext

userId: string

Returns Promise<string[]>

getClaimValue:function

Type Parameters

T

Parameters

input: { claim: SessionClaim<T>; sessionHandle: string; userContext: UserContext }

claim: SessionClaim<T>

sessionHandle: string

userContext: UserContext

Returns Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: T | undefined }>

getGlobalClaimValidators:function

Parameters

input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; recipeUserId: RecipeUserId; tenantId: string; userContext: UserContext; userId: string }

claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]

recipeUserId: RecipeUserId

tenantId: string

userContext: UserContext

userId: string

Returns SessionClaimValidator[] | Promise<SessionClaimValidator[]>

getSession:function

Parameters

input: { accessToken: string | undefined; antiCsrfToken?: string; options?: VerifySessionOptions; userContext: UserContext }

accessToken: string | undefined

Optional antiCsrfToken?: string

Optional options?: VerifySessionOptions

userContext: UserContext