Which UI do you use?

Custom UI

Pre built UI

Pre API Hook

This function is called before any API call is being made to your backend from our frontend SDK. You can use this to change the request body / url / header or any other request property.

ReactJS

Important

SuperTokens does not provide non-React UI components. So we will be using the supertokens-auth-react SDK and will inject the React components to show the UI. Therefore, the code snippet below refers to the supertokens-auth-react SDK.

import ThirdParty from "supertokens-auth-react/recipe/thirdparty";

ThirdParty.init({
    preAPIHook: async (context) => {
        let url = context.url;
        
        // is the fetch config object that contains the header, body etc..
        let requestInit = context.requestInit;

        let action = context.action;
        if (action === "GET_AUTHORISATION_URL") {

        } else if (action === "THIRD_PARTY_SIGN_IN_UP") {
            // Note: this could either be sign in or sign up.
            // we don't know that at the time of the API call
            // since all we have is the authorisation code from
            // the social provider
        }

        // events such as sign out are in the 
        // session recipe pre API hook (See the info box below)
        return {
            requestInit, url
        };
    }
})

Angular

Important

SuperTokens does not provide non-React UI components. So we will be using the supertokens-auth-react SDK and will inject the React components to show the UI. Therefore, the code snippet below refers to the supertokens-auth-react SDK.

import ThirdParty from "supertokens-auth-react/recipe/thirdparty";

ThirdParty.init({
    preAPIHook: async (context) => {
        let url = context.url;
        
        // is the fetch config object that contains the header, body etc..
        let requestInit = context.requestInit;

        let action = context.action;
        if (action === "GET_AUTHORISATION_URL") {

        } else if (action === "THIRD_PARTY_SIGN_IN_UP") {
            // Note: this could either be sign in or sign up.
            // we don't know that at the time of the API call
            // since all we have is the authorisation code from
            // the social provider
        }

        // events such as sign out are in the 
        // session recipe pre API hook (See the info box below)
        return {
            requestInit, url
        };
    }
})

Vue

import ThirdParty from "supertokens-auth-react/recipe/thirdparty";

ThirdParty.init({
    preAPIHook: async (context) => {
        let url = context.url;
        
        // is the fetch config object that contains the header, body etc..
        let requestInit = context.requestInit;

        let action = context.action;
        if (action === "GET_AUTHORISATION_URL") {

        } else if (action === "THIRD_PARTY_SIGN_IN_UP") {
            // Note: this could either be sign in or sign up.
            // we don't know that at the time of the API call
            // since all we have is the authorisation code from
            // the social provider
        }

        // events such as sign out are in the 
        // session recipe pre API hook (See the info box below)
        return {
            requestInit, url
        };
    }
})

info

Also checkout the session recipe pre API hook for events such as sign out. These will need to go in the Session.init config object.

Reading custom request information in the backend

Visit this page to learn how to read custom headers etc from the request on the backend.