Which UI do you use?

Custom UI

Pre built UI

Implementing sign out

The signOut method revokes the session on the frontend and on the backend. Calling this function without a valid session also yields a successful response.

Web

Via NPM

import Session from "supertokens-web-js/recipe/session";

async function logout () {
  await Session.signOut(); 
  window.location.href = "/auth"; // or to wherever your logic page is
}

Via Script Tag

async function logout () {
  await supertokensSession.signOut(); 
  window.location.href = "/auth"; // or to wherever your logic page is
}

Mobile

React Native

import SuperTokens from "supertokens-react-native";

async function logout () {
  await SuperTokens.signOut(); 
  // navigate to the login screen..
}

Android

import android.app.Application
import com.supertokens.session.SuperTokens

class MainApplication: Application() {
    fun logout() {
        SuperTokens.signOut(this);
        // navigate to the login screen..
    }
}

iOS

import UIKit
import SuperTokensIOS

class ViewController: UIViewController {
  func signOut() {
    SuperTokens.signOut(completionHandler: {
        error in
        
        if error != nil {
            // handle error
        } else {
            // Signed out successfully
        }
    })
  }
}

Flutter

import 'package:supertokens_flutter/supertokens.dart';

Future<void> signOut() async {
  await SuperTokens.signOut(
    completionHandler: (error) {
      // handle error if any
    }
  );
}

• On success, the signOut function does not redirect the user to another page, so you must redirect the user yourself.
• The signOut function calls the signout API exposed by the session recipe on the backend.
• If you call the signOut function whilst the access token has expired, but the refresh token still exists, our SDKs will do an automatic session refresh before revoking the session.

See also

• Revoking a session on the backend