Module recipe/session

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

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

verifySession:function

• verifySession(input: { options: APIOptions; userContext: any; verifySessionOptions: VerifySessionOptions | undefined }): Promise<undefined | SessionContainer>

• Parameters

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

    • options: APIOptions

    • userContext: any

    • verifySessionOptions: VerifySessionOptions | undefined

  Returns Promise<undefined | SessionContainer>

config: TypeNormalisedInput

isInServerlessEnv: boolean

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

createNewSession:function

• createNewSession(input: { accessTokenPayload?: any; res: BaseResponse; sessionData?: any; userContext: any; userId: string }): Promise<SessionContainer>

• Parameters

  • input: { accessTokenPayload?: any; res: BaseResponse; sessionData?: any; userContext: any; userId: string }

    • Optional accessTokenPayload?: any

    • res: BaseResponse

    • Optional sessionData?: any

    • userContext: any

    • userId: string

  Returns Promise<SessionContainer>

getAccessTokenLifeTimeMS:function

• getAccessTokenLifeTimeMS(input: { userContext: any }): Promise<number>

• Parameters

  • input: { userContext: any }

    • userContext: any

  Returns Promise<number>

getAllSessionHandlesForUser:function

• getAllSessionHandlesForUser(input: { userContext: any; userId: string }): Promise<string[]>

• Parameters

  • input: { userContext: any; userId: string }

    • userContext: any

    • userId: string

  Returns Promise<string[]>

getRefreshTokenLifeTimeMS:function

• getRefreshTokenLifeTimeMS(input: { userContext: any }): Promise<number>

• Parameters

  • input: { userContext: any }

    • userContext: any

  Returns Promise<number>

getSession:function

• getSession(input: { options?: VerifySessionOptions; req: BaseRequest; res: BaseResponse; userContext: any }): Promise<undefined | SessionContainer>

• Parameters

  • input: { options?: VerifySessionOptions; req: BaseRequest; res: BaseResponse; userContext: any }

    • Optional options?: VerifySessionOptions

    • req: BaseRequest

    • res: BaseResponse

    • userContext: any

  Returns Promise<undefined | SessionContainer>

getSessionInformation:function

• getSessionInformation(input: { sessionHandle: string; userContext: any }): Promise<SessionInformation>

• Used to retrieve all session information for a given session handle. Can be used in place of:

  • getSessionData
  • getAccessTokenPayload

  Parameters

  • input: { sessionHandle: string; userContext: any }

    • sessionHandle: string

    • userContext: any

  Returns Promise<SessionInformation>

refreshSession:function

• refreshSession(input: { req: BaseRequest; res: BaseResponse; userContext: any }): Promise<SessionContainer>

• Parameters

  • input: { req: BaseRequest; res: BaseResponse; userContext: any }

    • req: BaseRequest

    • res: BaseResponse

    • userContext: any

  Returns Promise<SessionContainer>

regenerateAccessToken:function

• regenerateAccessToken(input: { accessToken: string; newAccessTokenPayload?: any; userContext: any }): Promise<{ accessToken?: { createdTime: number; expiry: number; token: string }; session: { handle: string; userDataInJWT: any; userId: string }; status: "OK" }>

• Parameters

  • input: { accessToken: string; newAccessTokenPayload?: any; userContext: any }

    • accessToken: string

    • Optional newAccessTokenPayload?: any

    • userContext: any

  Returns Promise<{ accessToken?: { createdTime: number; expiry: number; token: string }; session: { handle: string; userDataInJWT: any; userId: string }; status: "OK" }>

revokeAllSessionsForUser:function

• revokeAllSessionsForUser(input: { userContext: any; userId: string }): Promise<string[]>

• Parameters

  • input: { userContext: any; userId: string }

    • userContext: any

    • userId: string

  Returns Promise<string[]>

revokeMultipleSessions:function

• revokeMultipleSessions(input: { sessionHandles: string[]; userContext: any }): Promise<string[]>

• Parameters

  • input: { sessionHandles: string[]; userContext: any }

    • sessionHandles: string[]

    • userContext: any

  Returns Promise<string[]>

revokeSession:function

• revokeSession(input: { sessionHandle: string; userContext: any }): Promise<boolean>

• Parameters

  • input: { sessionHandle: string; userContext: any }

    • sessionHandle: string

    • userContext: any

  Returns Promise<boolean>

updateAccessTokenPayload:function

• updateAccessTokenPayload(input: { newAccessTokenPayload: any; sessionHandle: string; userContext: any }): Promise<void>

• Parameters

  • input: { newAccessTokenPayload: any; sessionHandle: string; userContext: any }

    • newAccessTokenPayload: any

    • sessionHandle: string

    • userContext: any

  Returns Promise<void>

updateSessionData:function

• updateSessionData(input: { newSessionData: any; sessionHandle: string; userContext: any }): Promise<void>

• Parameters

  • input: { newSessionData: any; sessionHandle: string; userContext: any }

    • newSessionData: any

    • sessionHandle: string

    • userContext: any

  Returns Promise<void>

accessTokenPayload: any

expiry: number

sessionData: any

sessionHandle: string

timeCreated: number

userId: string