RecipeInterface
RecipeInterface: { createNewSession: any; getAccessTokenLifeTimeMS: any; getAllSessionHandlesForUser: any; getRefreshTokenLifeTimeMS: any; getSession: any; getSessionInformation: any; refreshSession: any; regenerateAccessToken: any; revokeAllSessionsForUser: any; revokeMultipleSessions: any; revokeSession: any; updateAccessTokenPayload: any; updateSessionData: any }
Type declaration
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
Optional sessionData?: any
userContext: any
userId: string
getAccessTokenLifeTimeMS:function
- getAccessTokenLifeTimeMS(input: { userContext: any }): Promise<number>
Parameters
input: { 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 }
Returns Promise<number>
getSession:function
getSessionInformation:function
- getSessionInformation(input: { sessionHandle: string; userContext: any }): Promise<SessionInformation>
Parameters
input: { sessionHandle: string; userContext: any }
sessionHandle: string
userContext: any
refreshSession:function
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>
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