Session Verification using getSession

caution

Please use the verifySession middleware whenever possible as it is simpler to use.

Requiring an active session

NodeJS

Express

import express from "express";import Session from "supertokens-node/recipe/session";
let app = express();
app.post("/like-comment", async (req, res) => {
    let session = await Session.getSession(req, res);
    if (session === undefined) {        throw Error("Should never come here")    }
    let userId = session.getUserId();    //....});

Hapi

import Hapi from "@hapi/hapi";import Session from "supertokens-node/recipe/session";
let server = Hapi.server({ port: 8000 });
server.route({    path: "/like-comment",    method: "post",    handler: async (req, res) => {        let session = await Session.getSession(req, res);
        if (session === undefined) {            throw Error("Should never come here")        }        let userId = session.getUserId();        //...    }})

Fastify

import Fastify from "fastify";import Session from "supertokens-node/recipe/session";
let fastify = Fastify();
fastify.post("/like-comment", async (req, res) => {    let session = await Session.getSession(req, res);
    if (session === undefined) {        throw Error("Should never come here")    }    let userId = session.getUserId();    //....});

Koa

import Session from "supertokens-node/recipe/session";import { middleware } from "supertokens-node/framework/awsLambda";import { SessionEvent } from "supertokens-node/framework/awsLambda";
async function likeComment(awsEvent: SessionEvent) {    let session = await Session.getSession(awsEvent, awsEvent);
    if (session === undefined) {        throw Error("Should never come here")    }    let userId = session.getUserId();    //....};
exports.handler = middleware(likeComment);

Loopback

import KoaRouter from "koa-router";import Session from "supertokens-node/recipe/session";
let router = new KoaRouter();
router.post("/like-comment", async (ctx, next) => {    let session = await Session.getSession(ctx, ctx);
    if (session === undefined) {        throw Error("Should never come here")    }    let userId = session.getUserId();    //....});

AWS Lambda / Netlify

import { inject } from "@loopback/core";import { RestBindings, MiddlewareContext, post, response } from "@loopback/rest";import Session from "supertokens-node/recipe/session";
class LikeComment {    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }    @post("/like-comment")    @response(200)    async handler() {        let session = await Session.getSession(this.ctx, this.ctx);
        if (session === undefined) {            throw Error("Should never come here")        }        let userId = session.getUserId();        //....    }}

Next.js

import { superTokensNextWrapper } from 'supertokens-node/nextjs'import Session from "supertokens-node/recipe/session";import { SessionRequest } from "supertokens-node/framework/express";
export default async function likeComment(req: SessionRequest, res: any) {    let session = await superTokensNextWrapper(        async (next) => {            return await Session.getSession(req, res);        },        req,        res    )
    if (session === undefined) {        throw Error("Should never come here")    }    let userId = session.getUserId();    //....}

NestJS

import { Controller, Post, UseGuards, Req, Res } from "@nestjs/common";import type { Request, Response } from "express";import { AuthGuard } from './auth/auth.guard';import Session from "supertokens-node/recipe/session";
@Controller()export class ExampleController {  @Post('example')  @UseGuards(AuthGuard)  async postExample(@Req() req: Request, @Res({passthrough: true}) res: Response): Promise<boolean> {    // This should be done inside a parameter decorator, for more information please read our NestJS guide.    const session = await Session.getSession(req, res);
    if (session === undefined) {        throw Error("Should never come here")    }    const userId = session.getUserId();    //....    return true;  }}

GoLang

import (    "fmt"    "net/http"
    "github.com/supertokens/supertokens-golang/recipe/session"    "github.com/supertokens/supertokens-golang/supertokens")
func likeCommentAPI(w http.ResponseWriter, r *http.Request) {    sessionContainer, err := session.GetSession(r, w, nil)
    if err != nil {        err = supertokens.ErrorHandler(err, r, w)        if err != nil {            // TODO: send 500 to client        }        return    }
    userID := sessionContainer.GetUserID()
    // TODO: API logic...    fmt.Println(userID)}

Python

FastAPI

from supertokens_python.recipe.session.asyncio import get_sessionfrom fastapi.requests import Request
@app.post('/like-comment') async def like_comment(request: Request):    session = await get_session(request)
    if session is None:        raise Exception("Should never come here")
    user_id = session.get_user_id()
    print(user_id)    # TODO

Flask

from supertokens_python.recipe.session.syncio import get_sessionfrom flask.wrappers import Request
@app.route('/like-comment', methods=['POST']) def like_comment(request: Request):    session = get_session(request)
    if session is None:        raise Exception("Should never come here")
    user_id = session.get_user_id()
    print(user_id)     # TODO

Django

from supertokens_python.recipe.session.asyncio import get_sessionfrom django.http import HttpRequest
async def like_comment(request: HttpRequest):    session = await get_session(request)    if session is None:        raise Exception("Should never come here")
    user_id = session.get_user_id()
    print(user_id) # TODO

Optional session verification

Sometimes, you want an API to be accessible even if there is no session. In that case, you can use the sessionRequired flag:

NodeJS

Express

import express from "express";import Session from "supertokens-node/recipe/session";
let app = express();
app.post("/like-comment", async (req, res) => {
    let session = await Session.getSession(req, res, { sessionRequired: false })
    if (session !== undefined) {        let userId = session.getUserId();    } else {        // user is not logged in...    }    //....});

Hapi

import Hapi from "@hapi/hapi";import Session from "supertokens-node/recipe/session";
let server = Hapi.server({ port: 8000 });
server.route({    path: "/like-comment",    method: "post",
    handler: async (req, res) => {        let session = await Session.getSession(req, res, { sessionRequired: false })
        if (session !== undefined) {            let userId = session.getUserId();        } else {            // user is not logged in...        }
        //...    }})

Fastify

import Fastify from "fastify";import Session from "supertokens-node/recipe/session";
let fastify = Fastify();
fastify.post("/like-comment", async (req, res) => {    let session = await Session.getSession(req, res, { sessionRequired: false })
    if (session !== undefined) {        let userId = session.getUserId();    } else {        // user is not logged in...    }    //....});

Koa

import Session from "supertokens-node/recipe/session";import { middleware } from "supertokens-node/framework/awsLambda";import { SessionEvent } from "supertokens-node/framework/awsLambda";
async function likeComment(awsEvent: SessionEvent) {    let session = await Session.getSession(awsEvent, awsEvent, { sessionRequired: false })
    if (session !== undefined) {        let userId = session.getUserId();    } else {        // user is not logged in...    }
    //....};
exports.handler = middleware(likeComment);

Loopback

import KoaRouter from "koa-router";import Session from "supertokens-node/recipe/session";
let router = new KoaRouter();
router.post("/like-comment", async (ctx, next) => {    let session = await Session.getSession(ctx, ctx, { sessionRequired: false })
    if (session !== undefined) {        let userId = session.getUserId();    } else {        // user is not logged in...    }
    //....});

AWS Lambda / Netlify

import { inject } from "@loopback/core";import { RestBindings, MiddlewareContext, post, response } from "@loopback/rest";import Session from "supertokens-node/recipe/session";
class LikeComment {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }    @post("/like-comment")    @response(200)    async handler() {        let session = await Session.getSession(this.ctx, this.ctx, { sessionRequired: false })
        if (session !== undefined) {            let userId = session.getUserId();        } else {            // user is not logged in...        }
        //....    }}

Next.js

import { superTokensNextWrapper } from 'supertokens-node/nextjs'import Session from "supertokens-node/recipe/session";import { SessionRequest } from "supertokens-node/framework/express";
export default async function likeComment(req: SessionRequest, res: any) {    let session = await superTokensNextWrapper(        async (next) => {            return await Session.getSession(req, res, { sessionRequired: false });        },        req,        res    )
    if (session !== undefined) {        let userId = session.getUserId();    } else {        // user is not logged in...    }    //....}

NestJS

import { Controller, Post, UseGuards, Req, Res } from "@nestjs/common";import type { Request, Response } from "express";import { AuthGuard } from './auth/auth.guard';import Session from "supertokens-node/recipe/session";
@Controller()export class ExampleController {  @Post('example')  @UseGuards(AuthGuard)  async postExample(@Req() req: Request, @Res({ passthrough: true }) res: Response): Promise<boolean> {    // This should be done inside a parameter decorator, for more information please read our NestJS guide.    const session = await Session.getSession(req, res, { sessionRequired: false })
    if (session !== undefined) {      const userId = session.getUserId();    } else {      // user is not logged in...    }    //....    return true;  }}

GoLang

import (    "fmt"    "net/http"
    "github.com/supertokens/supertokens-golang/recipe/session"    "github.com/supertokens/supertokens-golang/recipe/session/sessmodels"    "github.com/supertokens/supertokens-golang/supertokens")
func likeCommentAPI(w http.ResponseWriter, r *http.Request) {    sessionRequired := false    sessionContainer, err := session.GetSession(r, w, &sessmodels.VerifySessionOptions{        SessionRequired: &sessionRequired,    })
    if err != nil {        err = supertokens.ErrorHandler(err, r, w)        if err != nil {            // TODO: send 500 to client        }        return    }    if sessionContainer != nil {        // session exists        userID := sessionContainer.GetUserID()        fmt.Println(userID)    } else {        // user is not logged in    }}

Python

FastAPI

from supertokens_python.recipe.session.asyncio import get_sessionfrom fastapi import Request
@app.post('/like-comment') async def like_comment(request: Request):    session = await get_session(request, session_required=False)
    if session is not None:        user_id = session.get_user_id()        print(user_id) # TODO:    else:       pass # user is not logged in

Flask

from supertokens_python.recipe.session.syncio import get_sessionfrom flask.wrappers import Request
@app.route('/like-comment', methods=['POST']) def like_comment(request: Request):    session = get_session(request, session_required=False)
    if session is not None:        user_id = session.get_user_id()        print(user_id) # TODO..    else:        pass # user is not logged in

Django

from django.http import HttpRequestfrom supertokens_python.recipe.session.asyncio import get_session
async def like_comment(request: HttpRequest):    session = await get_session(request, session_required=False)
    if session is not None:        user_id = session.get_user_id()        print(user_id) # TODO..    else:        pass # user is not logged in