Which UI do you use?

Custom UI

Pre built UI

Get User Info

You can fetch user information on the backend as well as on the frontend.

Fetching on the backend

Using getUserByEmail

NodeJS

Important

For other backend frameworks, you can follow our guide on how to spin up a separate server configured with the SuperTokens backend SDK to authenticate requests and issue session tokens.

GoLang

You can get a user's information on the backend using the getUserByEmail, getUserByPhoneNumber and getUserById functions:

import Passwordless from "supertokens-node/recipe/passwordless";

async function handler() {
    const userInfo = await Passwordless.getUserByEmail({email: "test@example.com"});
}

Python

You can get a user's information on the backend using the GetUserByEmail, GetUserByPhoneNumber and GetUserById functions:

import (
    "fmt"

    "github.com/supertokens/supertokens-golang/recipe/passwordless"
)

func main() {

    userInfo, err := passwordless.GetUserByEmail("test@example.com")
    if err != nil {
        // TODO: Handle error
        return
    }
    fmt.Println(userInfo)
    //...
}

Other Frameworks

Asyncio

from supertokens_python.recipe.passwordless.asyncio import get_user_by_email

async def some_func():
    _ = await get_user_by_email("test@example.com")

Syncio

from supertokens_python.recipe.passwordless.syncio import get_user_by_email

user_info = get_user_by_email("test@example.com")

Using getUserByPhoneNumber

NodeJS

Important

For other backend frameworks, you can follow our guide on how to spin up a separate server configured with the SuperTokens backend SDK to authenticate requests and issue session tokens.

GoLang

import Passwordless from "supertokens-node/recipe/passwordless";

async function handler() {
    const userInfo = await Passwordless.getUserByPhoneNumber({phoneNumber: "+1234567891"});
}

Python

import (
    "fmt"

    "github.com/supertokens/supertokens-golang/recipe/passwordless"
)

func main() {

    userInfo, err := passwordless.GetUserByPhoneNumber("+1234567890")
    if err != nil {
        // TODO: Handle error
        return
    }
    fmt.Println(userInfo)
    //...
}

Other Frameworks

Asyncio

from supertokens_python.recipe.passwordless.asyncio import get_user_by_phone_number

async def some_func():
    _ = await get_user_by_phone_number("+1234567890")

Syncio

from supertokens_python.recipe.passwordless.syncio import get_user_by_phone_number

user_info = get_user_by_phone_number("+1234567890")

Using getUserById

NodeJS

Important

For other backend frameworks, you can follow our guide on how to spin up a separate server configured with the SuperTokens backend SDK to authenticate requests and issue session tokens.

GoLang

Express

import express from "express";

import Passwordless from "supertokens-node/recipe/passwordless";
import { verifySession } from "supertokens-node/recipe/session/framework/express";

const app = express();

app.get("/get-user-info", verifySession(), async (req, res) => {
    let userId = req.session.getUserId();

    let userInfo = await Passwordless.getUserById({userId})
    // ... 
})

Hapi

import Hapi, { Request } from "@hapi/hapi";

const server = Hapi.server();

import Passwordless from "supertokens-node/recipe/passwordless";
import { SessionContainer } from "supertokens-node/recipe/session";
import { verifySession } from "supertokens-node/recipe/session/framework/hapi";

server.route({
    path: "/get-user-info",
    method: "get",
    options: {
        pre: [
            {
                method: verifySession()
            },
        ],
    },
    handler: async (req: Request & { session: SessionContainer}, res) => {
        let userId = req.session.getUserId();
        let userInfo = await Passwordless.getUserById({userId});
        //...
    }
})

Fastify

import Fastify from "fastify";
import Passwordless from "supertokens-node/recipe/passwordless";
import { verifySession } from "supertokens-node/recipe/session/framework/fastify";

const fastify = Fastify();

fastify.post("/like-comment", {
    preHandler: verifySession(),
}, async (req, res) => {
    let userId = req.session.getUserId();
    let userInfo = await Passwordless.getUserById({userId});
    //....
});

Koa

import Passwordless from "supertokens-node/recipe/passwordless";
import { SessionEventV2 } from "supertokens-node/framework/awsLambda";
import { verifySession } from "supertokens-node/recipe/session/framework/awsLambda";

async function getUserInfo(awsEvent: SessionEventV2, _: any) {
    let userId = awsEvent.session!.getUserId();
    let userInfo = await Passwordless.getUserById({userId});
    //....
};

exports.handler = verifySession(getUserInfo);

Loopback

import KoaRouter from "koa-router";
import Passwordless from "supertokens-node/recipe/passwordless";
import { verifySession } from "supertokens-node/recipe/session/framework/koa";

const router = new KoaRouter();
router.get("/get-user-info", verifySession(), async (ctx, next) => {
    let userId = ctx.session!.getUserId();
    let userInfo = await Passwordless.getUserById({userId});
    //....
});

AWS Lambda / Netlify

import { inject, intercept } from '@loopback/core';
import { get, response, MiddlewareContext, RestBindings } from '@loopback/rest';

import  Passwordless from "supertokens-node/recipe/passwordless";
import { verifySession } from "supertokens-node/recipe/session/framework/loopback";
import Session from "supertokens-node/recipe/session";

class GetUserInfo {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) {}
    @get("/get-user-info")
    @intercept(verifySession())
    @response(200)
    async handler() {
        let userId = ((this.ctx as any).session as Session.SessionContainer).getUserId();
        let userInfo = await Passwordless.getUserById({userId});
        //....
    }
}

Next.js

import { SessionRequest } from 'supertokens-node/framework/express';
import  Passwordless from "supertokens-node/recipe/passwordless";
import { superTokensNextWrapper } from 'supertokens-node/nextjs'
import { verifySession } from "supertokens-node/recipe/session/framework/express";

export default async function likeComment(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession()(req, res, next);
        },
        req,
        res
    )

    let userId = req.session!.getUserId(); 
    let userInfo = await Passwordless.getUserById({userId}); 
    //....
}

NestJS

import { Controller, Post, UseGuards, Session } from '@nestjs/common';
import  Passwordless from "supertokens-node/recipe/passwordless";
import { SessionContainer } from "supertokens-node/recipe/session";

import { AuthGuard } from './auth/auth.guard';

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard()) // For more information about this guard please read our NestJS guide.
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    let userId = session.getUserId();
    let userInfo = await Passwordless.getUserById({userId}); 
    //....
    return false;
  }
}

Python

Chi

import (
    "fmt"
    "net/http"

    "github.com/supertokens/supertokens-golang/recipe/passwordless"
    "github.com/supertokens/supertokens-golang/recipe/session"
)

func main() {
    _ = http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
        session.VerifySession(nil, getUserInfoAPI).ServeHTTP(rw, r)
    })
}

func getUserInfoAPI(w http.ResponseWriter, r *http.Request) {
    sessionContainer := session.GetSessionFromRequestContext(r.Context())

    userID := sessionContainer.GetUserID()
    userInfo, err := passwordless.GetUserByID(userID)
    if err != nil {
        // TODO: Handle error
        return
    }

    fmt.Println(userInfo)

}

net/http

import (
    "fmt"
    "net/http"

    "github.com/gin-gonic/gin"
    "github.com/supertokens/supertokens-golang/recipe/passwordless"
    "github.com/supertokens/supertokens-golang/recipe/session"
    "github.com/supertokens/supertokens-golang/recipe/session/sessmodels"
)

func main() {
    router := gin.New()
    router.GET("/getuserinfo", verifySession(nil), getUserInfoAPI)
}

func verifySession(options *sessmodels.VerifySessionOptions) gin.HandlerFunc {
    return func(c *gin.Context) {
        session.VerifySession(options, func(rw http.ResponseWriter, r *http.Request) {
            c.Request = c.Request.WithContext(r.Context())
            c.Next()
        })(c.Writer, c.Request)
        // we call Abort so that the next handler in the chain is not called, unless we call Next explicitly
        c.Abort()
    }
}

func getUserInfoAPI(c *gin.Context) {
    sessionContainer := session.GetSessionFromRequestContext(c.Request.Context())

    userID := sessionContainer.GetUserID()

    userInfo, err := passwordless.GetUserByID(userID)
    if err != nil {
        // TODO: Handle error
        return
    }
    fmt.Println(userInfo)
    //...
}

Gin

import (
    "fmt"
    "net/http"

    "github.com/go-chi/chi"
    "github.com/supertokens/supertokens-golang/recipe/passwordless"
    "github.com/supertokens/supertokens-golang/recipe/session"
)

func main() {
    r := chi.NewRouter()
    r.Get("/getuserinfo", session.VerifySession(nil, getUserInfoAPI))
}

func getUserInfoAPI(w http.ResponseWriter, r *http.Request) {
    sessionContainer := session.GetSessionFromRequestContext(r.Context())

    userID := sessionContainer.GetUserID()
    userInfo, err := passwordless.GetUserByID(userID)
    if err != nil {
        // TODO: Handle error
        return
    }
    fmt.Println(userInfo)
}

Mux

import (
    "fmt"
    "net/http"

    "github.com/gorilla/mux"
    "github.com/supertokens/supertokens-golang/recipe/passwordless"
    "github.com/supertokens/supertokens-golang/recipe/session"
)

func main() {
    router := mux.NewRouter()
    router.HandleFunc("/getuserinfo", session.VerifySession(nil, getUserInfoAPI)).Methods(http.MethodGet)
}

func getUserInfoAPI(w http.ResponseWriter, r *http.Request) {
    sessionContainer := session.GetSessionFromRequestContext(r.Context())

    userID := sessionContainer.GetUserID()
    userInfo, err := passwordless.GetUserByID(userID)
    if err != nil {
        // TODO: Handle error
        return
    }
    fmt.Println(userInfo)
}

Other Frameworks

FastAPI

from supertokens_python.recipe.session.framework.fastapi import verify_session
from supertokens_python.recipe.passwordless.asyncio import get_user_by_id
from supertokens_python.recipe.session import SessionContainer
from fastapi import Depends

@app.post('/get_user_info_api') 
async def get_user_info_api(session: SessionContainer = Depends(verify_session())):
    user_id = session.get_user_id()

    _ = await get_user_by_id(user_id)

Flask

from supertokens_python.recipe.session.framework.flask import verify_session
from supertokens_python.recipe.passwordless.syncio import get_user_by_id
from supertokens_python.recipe.session import SessionContainer
from flask import g

@app.route('/update-jwt', methods=['POST']) 
@verify_session()
def get_user_info_api():
    session: SessionContainer = g.supertokens 

    user_id = session.get_user_id()

    _ = get_user_by_id(user_id)

Django

from supertokens_python.recipe.session.framework.django.asyncio import verify_session
from supertokens_python.recipe.passwordless.asyncio import get_user_by_id
from django.http import HttpRequest
from supertokens_python.recipe.session import SessionContainer

@verify_session()
async def get_user_info_api(request: HttpRequest):
    session: SessionContainer = request.supertokens 

    user_id = session.get_user_id()

    _ = await get_user_by_id(user_id)

Fetching on the frontend

important

The function calls below require no API calls and read directly from the session information stored on the frontend. This makes them very quick.

ReactJS

import Session from 'supertokens-auth-react/recipe/session';

async function getUserInfo() {
    if (await Session.doesSessionExist()) {
        let userId = await Session.getUserId();
        let accessTokenPayload = await Session.getAccessTokenPayloadSecurely();
    }
}

Angular

With React Context

import React from "react";
import { useSessionContext } from 'supertokens-auth-react/recipe/session'; 

// Your dashboard component
function Dashboard(props: any) {
    let session = useSessionContext();

    if (session.loading) {
        return null;
    }

    let {doesSessionExist, userId, accessTokenPayload} = session;

    // doesSessionExist will always be true if this is wrapped in `<SessionAuth>`
    if (!doesSessionExist) {
        // TODO
    }

    let name = accessTokenPayload.userName;
}

Without React Context

import Session from 'supertokens-auth-react/recipe/session';

async function getUserInfo() {
    if (await Session.doesSessionExist()) {
        let userId = await Session.getUserId();
        let accessTokenPayload = await Session.getAccessTokenPayloadSecurely();
    }
}

Vue

import Session from 'supertokens-auth-react/recipe/session';

async function getUserInfo() {
    if (await Session.doesSessionExist()) {
        let userId = await Session.getUserId();
        let accessTokenPayload = await Session.getAccessTokenPayloadSecurely();
    }
}