Skip to main content

Testing with Postman

The following guide will go over the process of testing backend APIs with Postman. These APIs are automatically exposed via our backend SDK (/auth/* path).

  • Make sure that the EmailPassword Recipe is correctly setup in your backend
  • For the examples given below we will be running our backend on domain localhost and port 3001
  • The Open API spec for the APIs being tested can be found here.
  • Postman does cookie management on its own. So you don't need to manually set cookies on each request.

We recommend using cookie-based sessions while testing with Postman, to make use of the built-in cookie manager. This can be enabled by adding the "st-auth-mode: cookie" request header during the sign up API call as shown below.

You do not need to do this in your frontend code since our SDK does this for you.

1. Signup#

We will test the /auth/signup API by creating a user with an email as and password as testPass123.

  • In Postman, set the request type to POST. Set the body of the request to be raw JSON.

  • Set the URL to http://localhost:3001/auth/signup

  • In the Header tab, set key st-auth-mode with value cookie. This will advise the backend that you prefer cookie-based sessions. This can be overridden by backend settings, but it's respected by default.

  • Add the request JSON object to the body tab as shown in the image below

  • On a successful request, a new user session will be created, with the user object and session tokens being returned in the response.

Successful signup request in postman

You can see the session tokens set by the response by switching to the cookies tab

Viewing session tokens in cookies tab in postman

These cookies are:

  • sAccessToken
  • sRefreshToken

More information about these cookies can be found here

2. Session Verification#

  • We can also test APIs which require the user to be logged in.

  • For example, we have an API used to query user data with the verifySession middleware as shown below

// The following code snippet is an example API. You do not need to 
// implement it in your app
import express from "express";
import { verifySession } from "supertokens-node/recipe/session/framework/express";
import { SessionRequest } from "supertokens-node/framework/express";

let app = express();"/change-user-data", verifySession(), async (req: SessionRequest, res) => {
let userId = req.session!.getUserId();
// mutate some user data
  • In Postman, set the request type to POST.
  • Set the URL to http://localhost:3001/change-user-data
  • If you have the antiCsrf attribute set to VIA_TOKEN in your backend SuperTokens config, then, in the Postman Header tab, set the key as anti-csrf and value as the anti-csrf token retrieved from the login response.
  • On a successful response, the response body will contain user data

By default, for GET APIs, you don't need to provide the anti-csrf request header as anti-CSRF checks are only done in non-GET APIs

Request to change user data in postman

In case you query the /change-user-data API with an expired access token, you will get a 401 response with the message try refresh token.

Failed query due to expired access token in postman

To generate new session tokens you can use the /auth/session/refresh API as shown in the next section.

3. Refreshing Session Tokens#

In case your access token expires you can call the /auth/session/refresh api to generate a new access token and refresh token.

  • In Postman, set the request type to POST.
  • Set the URL as http://localhost:3001/auth/session/refresh
  • On a successful response, new session tokens will be set
Successful session refresh in postman

You can see the new session tokens by switching to the cookies tab

Viewing session tokens in cookies tab in postman

4. Logout#

The /auth/signout API will be used to invalidate the user sessions. This will clear the session cookies set in postman.

  • In Postman, set the request type to POST.
  • Set the URL as http://localhost:3001/auth/signout
  • On a successful response, the session tokens will be cleared from Postman, and from the database
Successful signout request in postman
Looking for older versions of the documentation?
Which UI do you use?
Custom UI
Pre built UI